Discuss this help topic in SecureBlackbox Forum

TElWinAzureDataStorage.ListInit

TElWinAzureDataStorage     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Initiates the LIST request.

Declaration

[C#/Java]
    TElWinAzureDataStorageListState ListInit(string ContainerName);
    TElWinAzureDataStorageListState ListInit(string ContainerName, string Prefix, string Delimiter, TElStringList Prefixes, TElStringList Headers);
    TElWinAzureDataStorageListState ListInit(string ContainerName, string SharedAccessSignature, string Prefix, string Delimiter, TElStringList Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList Headers);

[VB.NET]
    Function ListInit(ByVal ContainerName As String) As TElWinAzureDataStorageListState
    Function ListInit(ByVal ContainerName As String, ByVal Prefix As String, ByVal Delimiter As String, ByVal Prefixes As TElStringList, ByVal Headers As TElStringList) As TElWinAzureDataStorageListState
    Function ListInit(ByVal ContainerName As String, ByVal SharedAccessSignature As String, ByVal Prefix As String, ByVal Delimiter As String, ByVal Prefixes As TElStringList, ByVal IncludeSnapshots As Boolean, ByVal IncludeMetadata As Boolean, ByVal IncludeUncommittedBlobs As Boolean, ByVal Headers As TElStringList) As TElWinAzureDataStorageListState

[Pascal]
    function ListInit(const ContainerName : string) : TElWinAzureDataStorageListState;
    function ListInit(const ContainerName : string; const Prefix : string; const Delimiter : string; Prefixes : TStringList; Headers : TStringList) : TElWinAzureDataStorageListState;
    function ListInit(const ContainerName : string; const SharedAccessSignature : string; const Prefix : string; const Delimiter : string; Prefixes : TStringList; IncludeSnapshots, IncludeMetadata, IncludeUncommittedBlobs : boolean; Headers : TStringList) : TElWinAzureDataStorageListState;

[C++]
    TElWinAzureDataStorageListStateHandle ListInit(const std::string &ContainerName);
    TElWinAzureDataStorageListStateHandle ListInit(const std::string &ContainerName, const std::string &Prefix, const std::string &Delimiter, TElStringList &Prefixes, TElStringList &Headers);
    TElWinAzureDataStorageListStateHandle ListInit(const std::string &ContainerName, const std::string &Prefix, const std::string &Delimiter, TElStringList *Prefixes, TElStringList *Headers);
    TElWinAzureDataStorageListStateHandle ListInit(const std::string &ContainerName, const std::string &SharedAccessSignature, const std::string &Prefix, const std::string &Delimiter, TElStringList &Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList &Headers);
    TElWinAzureDataStorageListStateHandle ListInit(const std::string &ContainerName, const std::string &SharedAccessSignature, const std::string &Prefix, const std::string &Delimiter, TElStringList *Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList *Headers);

[PHP]
    TElWinAzureDataStorageListState ListInit(string $ContainerName)
    TElWinAzureDataStorageListState ListInit(string $ContainerName, string $Prefix, string $Delimiter, TElStringList $Prefixes, TElStringList $Headers)
    TElWinAzureDataStorageListState ListInit(string $ContainerName, string $SharedAccessSignature, string $Prefix, string $Delimiter, TElStringList $Prefixes, bool $IncludeSnapshots, bool $IncludeMetadata, bool $IncludeUncommittedBlobs, TElStringList $Headers)

Parameters

  • ContainerName - name of the data container.
  • Delimiter - specifies the delimiter parameter of the request. If the delimiter parameter is present in the request, the response will contain a BlobPrefix element, which will include all blobs whose names begin with prefix up to the appearance of the delimiter character (string).
  • Headers - contains the headers of the HTTP request.
  • IncludeMetadata - specifies if the blob metadata should be included in the response.
  • IncludeSnapshots - specifies if the snapshots should be included to the enumeration.
  • IncludeUncommittedBlobs - specifies if blobs for which blocks have been uploaded, but which have not been committed using Put Block List (REST API), should be included to the response.
  • Prefix - specifies blob name prefix.
  • Prefixes - contains the BlobPrefix element of the response (if the delimiter was specified in the request).
  • SharedAccessSignature - contains the Shared Access Signature (SAS).

Return value

    Returns TElWinAzureDataStorageListState object which specifies the state of the request.

Description

    Call this method to initiate the LIST request. When the request is initiated, use the obtained TElWinAzureDataStorageListState object in subsequent calls to ListNext, to get the list of blobs from the server.

See also:     List     ListNext    

Discuss this help topic in SecureBlackbox Forum