DownloadFile
Downloads files from an attachment field in an app.
Input
Name | Type | Required | Accepts Output Streams | Description |
FileKey | String | True | False | The Id of the file. |
LocalPath | String | False | False | The local path to save the file to. |
FileName | String | False | False | The file name to save the files to. |
GuestSpaceId | String | False | False | This parameter is used for documents that are in the guest space. Do not add this parameter if the connection property GuestSpaceId is specified in the connection string. |
Encoding | String | False | False | The FileData input encoding type.
The allowed values are NONE, BASE64. The default value is BASE64. |
FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if LocalPath is not provided. |
Result Set Columns
Name | Type | Description |
FileData | String | Returns File data, if the LocalPath or FileStream input is empty. |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |