Discuss this help topic in SecureBlackbox Forum

TElWinAzureDataStorageContainer.List

TElWinAzureDataStorageContainer     See also     


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


Lists the objects in the data container.

Declaration

[C#/Java]
    void List(TElDataStorageObjectList Objects);
    void List(TElDataStorageObjectList Objects, string Prefix, string Delimiter, int MaxCount, TElStringList Prefixes, TElStringList Headers);
    void List(TElDataStorageObjectList Objects, string Prefix, string Delimiter, int MaxCount, TElStringList Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList Headers);
    void List(string SharedAccessSignature, TElDataStorageObjectList Objects);
    void List(string SharedAccessSignature, TElDataStorageObjectList Objects, string Prefix, string Delimiter, int MaxCount, TElStringList Prefixes, TElStringList Headers);
    void List(string SharedAccessSignature, TElDataStorageObjectList Objects, string Prefix, string Delimiter, int MaxCount, TElStringList Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList Headers);
    String[] List();
    String[] List(string Prefix, int MaxCount);
    String[] List(string Prefix, int MaxCount, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList Headers);
    String[] List(string SharedAccessSignature);
    String[] List(string SharedAccessSignature, string Prefix, int MaxCount);
    String[] List(string SharedAccessSignature, string Prefix, int MaxCount, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList Headers);

[VB.NET]
    Sub List(ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal Objects As TElDataStorageObjectList, ByVal Prefix As String, ByVal Delimiter As String, ByVal MaxCount As Integer, ByVal Prefixes As TElStringList, ByVal Headers As TElStringList)
    Sub List(ByVal Objects As TElDataStorageObjectList, ByVal Prefix As String, ByVal Delimiter As String, ByVal MaxCount As Integer, ByVal Prefixes As TElStringList, ByVal IncludeSnapshots As Boolean, ByVal IncludeMetadata As Boolean, ByVal IncludeUncommittedBlobs As Boolean, ByVal Headers As TElStringList)
    Sub List(ByVal SharedAccessSignature As String, ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal SharedAccessSignature As String, ByVal Objects As TElDataStorageObjectList, ByVal Prefix As String, ByVal Delimiter As String, ByVal MaxCount As Integer, ByVal Prefixes As TElStringList, ByVal Headers As TElStringList)
    Sub List(ByVal SharedAccessSignature As String, ByVal Objects As TElDataStorageObjectList, ByVal Prefix As String, ByVal Delimiter As String, ByVal MaxCount As Integer, ByVal Prefixes As TElStringList, ByVal IncludeSnapshots As Boolean, ByVal IncludeMetadata As Boolean, ByVal IncludeUncommittedBlobs As Boolean, ByVal Headers As TElStringList)
    Function List() As String[]
    Function List(ByVal Prefix As String, ByVal MaxCount As Integer) As String[]
    Function List(ByVal Prefix As String, ByVal MaxCount As Integer, ByVal IncludeSnapshots As Boolean, ByVal IncludeMetadata As Boolean, ByVal IncludeUncommittedBlobs As Boolean, ByVal Headers As TElStringList) As String[]
    Function List(ByVal SharedAccessSignature As String) As String[]
    Function List(ByVal SharedAccessSignature As String, ByVal Prefix As String, ByVal MaxCount As Integer) As String[]
    Function List(ByVal SharedAccessSignature As String, ByVal Prefix As String, ByVal MaxCount As Integer, ByVal IncludeSnapshots As Boolean, ByVal IncludeMetadata As Boolean, ByVal IncludeUncommittedBlobs As Boolean, ByVal Headers As TElStringList) As String[]

[Pascal]
    procedure List(Objects : TElDataStorageObjectList);
    procedure List(Objects : TElDataStorageObjectList; const Prefix : string; const Delimiter : string; MaxCount : integer; Prefixes : TStringList; Headers : TStringList);
    procedure List(Objects : TElDataStorageObjectList; const Prefix : string; const Delimiter : string; MaxCount : integer; Prefixes : TStringList; IncludeSnapshots, IncludeMetadata, IncludeUncommittedBlobs : boolean; Headers : TStringList);
    procedure List(const SharedAccessSignature : string; Objects : TElDataStorageObjectList);
    procedure List(const SharedAccessSignature : string; Objects : TElDataStorageObjectList; const Prefix : string; const Delimiter : string; MaxCount : integer; Prefixes : TStringList; Headers : TStringList);
    procedure List(const SharedAccessSignature : string; Objects : TElDataStorageObjectList; const Prefix : string; const Delimiter : string; MaxCount : integer; Prefixes : TStringList; IncludeSnapshots, IncludeMetadata, IncludeUncommittedBlobs : boolean; Headers : TStringList);

[C++]
    void List(TElDataStorageObjectList &Objects);
    void List(TElDataStorageObjectList *Objects);
    void List(TElDataStorageObjectList &Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList &Prefixes, TElStringList &Headers);
    void List(TElDataStorageObjectList *Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList *Prefixes, TElStringList *Headers);
    void List(TElDataStorageObjectList &Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList &Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList &Headers);
    void List(TElDataStorageObjectList *Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList *Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList *Headers);
    void List(const std::string &SharedAccessSignature, TElDataStorageObjectList &Objects);
    void List(const std::string &SharedAccessSignature, TElDataStorageObjectList *Objects);
    void List(const std::string &SharedAccessSignature, TElDataStorageObjectList &Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList &Prefixes, TElStringList &Headers);
    void List(const std::string &SharedAccessSignature, TElDataStorageObjectList *Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList *Prefixes, TElStringList *Headers);
    void List(const std::string &SharedAccessSignature, TElDataStorageObjectList &Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList &Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList &Headers);
    void List(const std::string &SharedAccessSignature, TElDataStorageObjectList *Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList *Prefixes, bool IncludeSnapshots, bool IncludeMetadata, bool IncludeUncommittedBlobs, TElStringList *Headers);

[PHP]
    void List(TElDataStorageObjectList $Objects)
    void List(TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, TElStringList $Headers)
    void List(TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, bool $IncludeSnapshots, bool $IncludeMetadata, bool $IncludeUncommittedBlobs, TElStringList $Headers)
    void List(string $SharedAccessSignature, TElDataStorageObjectList $Objects)
    void List(string $SharedAccessSignature, TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, TElStringList $Headers)
    void List(string $SharedAccessSignature, TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, bool $IncludeSnapshots, bool $IncludeMetadata, bool $IncludeUncommittedBlobs, TElStringList $Headers)

Parameters

  • 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 HTTP request headers
  • 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.
  • MaxCount - specifies maximum number of blobs in the response.
  • Objects - list of the objects in the container
  • 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

    List of the data objects in the container.

Description

    Use this method to get a list of objects in the data container.

See also:     ListInit    

Discuss this help topic in SecureBlackbox Forum