Website Download Support
 

Discuss this help topic in SecureBlackbox Forum

TElWinAzureDataStorage.List

TElWinAzureDataStorage     See also     

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

Lists the blobs in the data container.

Declaration

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

[VB.NET]
    Sub List(ByVal ContainerName As String, ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal ContainerName As String, ByVal Objects As TElDataStorageObjectList, ByVal Headers As TElStringList)
    Sub List(ByVal ContainerName 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 ContainerName 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)
    Sub List(ByVal Container As TElWinAzureDataStorageContainer, ByVal Objects As TElDataStorageObjectList)
    Sub List(ByVal ContainerName As String, ByVal SharedAccessSignature As String, ByVal Objects As TElDataStorageObjectList, ByVal Headers As TElStringList)
    Sub List(ByVal ContainerName As String, 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 ContainerName As String, 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(ByVal ContainerName As String) As String[]
    Function List(ByVal Container As TElWinAzureDataStorageContainer) As String[]
    Function List(ByVal ContainerName As String, ByVal Headers As TElStringList) As String[]
    Function List(ByVal ContainerName As String, ByVal Prefix As String, ByVal MaxCount As Integer) As String[]
    Function List(ByVal ContainerName 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[]
    Function List(ByVal ContainerName As String, ByVal SharedAccessSignature As String) As String[]
    Function List(ByVal ContainerName As String, 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[]
    Sub List(ByVal Objs As TElDataStorageObjectList)

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

[C++]
    void List(const std::string &ContainerName, TElDataStorageObjectList &Objects);
    void List(const std::string &ContainerName, TElDataStorageObjectList *Objects);
    void List(const std::string &ContainerName, TElDataStorageObjectList &Objects, TElStringList &Headers);
    void List(const std::string &ContainerName, TElDataStorageObjectList *Objects, TElStringList *Headers);
    void List(const std::string &ContainerName, TElDataStorageObjectList &Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList &Prefixes, TElStringList &Headers);
    void List(const std::string &ContainerName, TElDataStorageObjectList *Objects, const std::string &Prefix, const std::string &Delimiter, int32_t MaxCount, TElStringList *Prefixes, TElStringList *Headers);
    void List(const std::string &ContainerName, 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 &ContainerName, 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(TElWinAzureDataStorageContainer &Container, TElDataStorageObjectList &Objects);
    void List(TElWinAzureDataStorageContainer *Container, TElDataStorageObjectList *Objects);
    void List(const std::string &ContainerName, const std::string &SharedAccessSignature, TElDataStorageObjectList &Objects, TElStringList &Headers);
    void List(const std::string &ContainerName, const std::string &SharedAccessSignature, TElDataStorageObjectList *Objects, TElStringList *Headers);
    void List(const std::string &ContainerName, 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 &ContainerName, 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 &ContainerName, 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 &ContainerName, 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(string $ContainerName, TElDataStorageObjectList $Objects)
    void List(string $ContainerName, TElDataStorageObjectList $Objects, TElStringList $Headers)
    void List(string $ContainerName, TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, TElStringList $Headers)
    void List(string $ContainerName, TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, bool $IncludeSnapshots, bool $IncludeMetadata, bool $IncludeUncommittedBlobs, TElStringList $Headers)
    void List(TElWinAzureDataStorageContainer $Container, TElDataStorageObjectList $Objects)
    void List(string $ContainerName, string $SharedAccessSignature, TElDataStorageObjectList $Objects, TElStringList $Headers)
    void List(string $ContainerName, string $SharedAccessSignature, TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, TElStringList $Headers)
    void List(string $ContainerName, string $SharedAccessSignature, TElDataStorageObjectList $Objects, string $Prefix, string $Delimiter, integer $MaxCount, TElStringList $Prefixes, bool $IncludeSnapshots, bool $IncludeMetadata, bool $IncludeUncommittedBlobs, TElStringList $Headers)
    void List(TElDataStorageObjectList $Objs)

[Java]
    void list(String ContainerName, String SharedAccessSignature, TElDataStorageObjectList Objects, String Prefix, String Delimiter, int MaxCount, TElStringList Prefixes, boolean IncludeSnapshots, boolean IncludeMetadata, boolean IncludeUncommittedBlobs, TElStringList Headers);
    void list(String ContainerName, String SharedAccessSignature, TElDataStorageObjectList Objects, String Prefix, String Delimiter, int MaxCount, TElStringList Prefixes, TElStringList Headers);
    String[] list(String ContainerName);
    void list(String ContainerName, String SharedAccessSignature, TElDataStorageObjectList Objects, TElStringList Headers);
    void list(TElWinAzureDataStorageContainer Container, TElDataStorageObjectList Objects);
    void list(String ContainerName, TElDataStorageObjectList Objects, String Prefix, String Delimiter, int MaxCount, TElStringList Prefixes, boolean IncludeSnapshots, boolean IncludeMetadata, boolean IncludeUncommittedBlobs, TElStringList Headers);
    String[] list(String ContainerName, String SharedAccessSignature, String Prefix, int MaxCount, boolean IncludeSnapshots, boolean IncludeMetadata, boolean IncludeUncommittedBlobs, TElStringList Headers);
    String[] list(String ContainerName, String SharedAccessSignature);
    String[] list(String ContainerName, String Prefix, int MaxCount, boolean IncludeSnapshots, boolean IncludeMetadata, boolean IncludeUncommittedBlobs, TElStringList Headers);
    String[] list(String ContainerName, String Prefix, int MaxCount);
    String[] list(String ContainerName, TElStringList Headers);
    String[] list(TElWinAzureDataStorageContainer Container);
    void list(String ContainerName, TElDataStorageObjectList Objects);
    void list(String ContainerName, TElDataStorageObjectList Objects, TElStringList Headers);
    void list(String ContainerName, TElDataStorageObjectList Objects, String Prefix, String Delimiter, int MaxCount, TElStringList Prefixes, TElStringList Headers);

Parameters

  • ContainerName - name of the data container.
  • Container - the data container which contents to list.
  • Objects - this parameter contains the return value, the list of objects in the container.
  • Headers - contains the headers of the HTTP request.
  • 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).
  • 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.
  • 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).
  • Objs - ...

Return value

    List of data objects (blobs) in the container.

Description

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

See also:     ListContainers    

Discuss this help topic in SecureBlackbox Forum

Copyright (c) 2018, /n software, inc.