ADO.NET Provider for IBM Cloud Object Storage

Build 24.0.9060

DownloadObject

Passes the name of a bucket and object to download.

Input

Name Type Required Accepts Output Streams Description
Bucket String True False Bucket name where the object is located.
Object String False False Object name for the object that should be retrieved. If not specified, all the objects from the specified bucket will be retrieved.
LocalFolderPath String False False The path, or URI, to the file that will receive the data of the object.
ByteRangeStart Long False False The start of the byte range to download.
ByteRangeEnd Long False False The end of the byte range to download.
Encoding String False False If the LocalFile input is left empty, the data will be output to FileData in the specified encoding.

The allowed values are NONE, BASE64.

The default value is BASE64.

FileStream String False True Stream containing the downloaded file if no LocalFolderPath is specified

Result Set Columns

Name Type Description
Success String Stored procedure execution status.
FileData String The base64encoded file data output, if the LocalPath input and OutData are not specified.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060