IPWorks Cloud 2020 PHP Edition

Questions / Feedback?

Prefix Property

A prefix used to restrict the results returned when listing blobs or containers.

Object Oriented Interface

public function getPrefix();
public function setPrefix($value);

Procedural Interface

ipworkscloud_azureblob_get($res, 69 );
ipworkscloud_azureblob_set($res, 69, $value );

Default Value

''

Remarks

This property, if non-empty, is used to restrict the results returned by ListBlobs or ListContainers to only the items whose names begin with the given value.

Blob Namespace Traversal

By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

  • MyCompany
  • MyCompany/Department1
  • MyCompany/Department2
  • MyCompany/Department2/EmployeeA
  • MyCompany/Department2/EmployeeB

With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:

Prefix Value Blobs Returned Prefixes Returned
(empty) MyCompany MyCompany/
MyCompany/ MyCompany/Department1
MyCompany/Department2
MyCompany/Department2/
MyCompany/Department2/ MyCompany/Department2/EmployeeA
MyCompany/Department2/EmployeeB
(none)

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 PHP Edition - Version 20.0 [Build 8265]