AuthAzureStorage Delphi DLL Reference Documentation

AuthAzureStorage

Current Version: 9.5.0.75

Provides functionality for authenticating calls to Azure Storage Services.

Create/Dispose

var
myObject: HCkAuthAzureStorage;

begin
myObject := CkAuthAzureStorage_Create();

// ...

CkAuthAzureStorage_Dispose(myObject);
end;
function CkAuthAzureStorage_Create: HCkAuthAzureStorage; stdcall;

Creates an instance of the HCkAuthAzureStorage object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkAuthAzureStorage_Dispose(handle: HCkAuthAzureStorage); stdcall;

Objects created by calling CkAuthAzureStorage_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AccessKey
procedure CkAuthAzureStorage_getAccessKey(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
procedure CkAuthAzureStorage_putAccessKey(objHandle: HCkAuthAzureStorage; newPropVal: PWideChar); stdcall;
function CkAuthAzureStorage__accessKey(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;
Introduced in version 9.5.0.58

A valid base64 access key for the Azure storage account.

More Information and Examples
top
Account
procedure CkAuthAzureStorage_getAccount(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
procedure CkAuthAzureStorage_putAccount(objHandle: HCkAuthAzureStorage; newPropVal: PWideChar); stdcall;
function CkAuthAzureStorage__account(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;
Introduced in version 9.5.0.58

The Azure storage account name. (A storage account can contain zero or more containers. A container contains properties, metadata, and zero or more blobs. A blob is any single entity comprised of binary data, properties, and metadata. )

top
DebugLogFilePath
procedure CkAuthAzureStorage_getDebugLogFilePath(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
procedure CkAuthAzureStorage_putDebugLogFilePath(objHandle: HCkAuthAzureStorage; newPropVal: PWideChar); stdcall;
function CkAuthAzureStorage__debugLogFilePath(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
procedure CkAuthAzureStorage_getLastErrorHtml(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
function CkAuthAzureStorage__lastErrorHtml(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
procedure CkAuthAzureStorage_getLastErrorText(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
function CkAuthAzureStorage__lastErrorText(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
procedure CkAuthAzureStorage_getLastErrorXml(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
function CkAuthAzureStorage__lastErrorXml(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
function CkAuthAzureStorage_getLastMethodSuccess(objHandle: HCkAuthAzureStorage): wordbool; stdcall;
procedure CkAuthAzureStorage_putLastMethodSuccess(objHandle: HCkAuthAzureStorage; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Scheme
procedure CkAuthAzureStorage_getScheme(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
procedure CkAuthAzureStorage_putScheme(objHandle: HCkAuthAzureStorage; newPropVal: PWideChar); stdcall;
function CkAuthAzureStorage__scheme(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;
Introduced in version 9.5.0.58

Can be "SharedKey" or "SharedKeyLite". The default value is "SharedKey".

top
Service
procedure CkAuthAzureStorage_getService(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
procedure CkAuthAzureStorage_putService(objHandle: HCkAuthAzureStorage; newPropVal: PWideChar); stdcall;
function CkAuthAzureStorage__service(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;
Introduced in version 9.5.0.58

Can be "Blob", "Queue", "File", or "Table". The default is "Blob".

top
VerboseLogging
function CkAuthAzureStorage_getVerboseLogging(objHandle: HCkAuthAzureStorage): wordbool; stdcall;
procedure CkAuthAzureStorage_putVerboseLogging(objHandle: HCkAuthAzureStorage; newPropVal: wordbool); stdcall;

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
procedure CkAuthAzureStorage_getVersion(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
function CkAuthAzureStorage__version(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;

Version of the component/library, such as "9.5.0.63"

top
XMsVersion
procedure CkAuthAzureStorage_getXMsVersion(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
procedure CkAuthAzureStorage_putXMsVersion(objHandle: HCkAuthAzureStorage; newPropVal: PWideChar); stdcall;
function CkAuthAzureStorage__xMsVersion(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;
Introduced in version 9.5.0.58

If set, automatically adds the "x-ms-version" HTTP request header to Azure Storage requests. The default value is "2014-02-14".

top

Methods

SaveLastError
function CkAuthAzureStorage_SaveLastError(objHandle: HCkAuthAzureStorage;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top