Data.Cloud.AmazonAPI.TAmazonStorageService.GetObjectProperties

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetObjectProperties(const BucketName, ObjectName: string;  OptionalParams: TAmazonGetObjectOptionals; out Properties, Metadata: TStrings; ResponseInfo: TCloudResponseInfo = nil; const BucketRegion: TAmazonRegion = amzrNotSpecified): Boolean; overload;
function GetObjectProperties(const BucketName, ObjectName: string;  out Properties, Metadata: TStrings; ResponseInfo: TCloudResponseInfo = nil; const BucketRegion: TAmazonRegion = amzrNotSpecified): Boolean; overload;

C++

bool __fastcall GetObjectProperties(const System::UnicodeString BucketName, const System::UnicodeString ObjectName, const TAmazonGetObjectOptionals &OptionalParams, /* out */ System::Classes::TStrings* &Properties, /* out */ System::Classes::TStrings* &Metadata, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), const System::UnicodeString BucketRegion = System::UnicodeString())/* overload */;
bool __fastcall GetObjectProperties(const System::UnicodeString BucketName, const System::UnicodeString ObjectName, /* out */ System::Classes::TStrings* &Properties, /* out */ System::Classes::TStrings* &Metadata, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), const System::UnicodeString BucketRegion = System::UnicodeString())/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonStorageService

Description

Returns the properties and metadata for the specified object.

There are two GetObjectProperties overloaded methods. To control the request, use the first overloaded method with the OptionalParams parameter.

GetObjectMetadata returns an empty list if no metadata was included in the object. The Response* fields of the OptionalParams instance are not used in this call.

The method returns True if the request was successful, False otherwise.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The name of the bucket the object is in.

ObjectName

The name of the object to get metadata for.

OptionalParams

The optional parameters or headers to use in the request.

Properties

The object's properties.

Metadata

The object's metadata.

ResponseInfo

The optional class for storing response info into.

See Also