AuthAzureStorage Delphi DLL Reference Documentation

AuthAzureStorage

Current Version: 10.1.2
Requires Chilkat Bundle License

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Azure Storage Blob Simple Upload
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. )

See the notes about PWideChar memory ownership and validity.

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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
procedure CkAuthAzureStorage_getLastErrorHtml(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
function CkAuthAzureStorage__lastErrorHtml(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

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

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
procedure CkAuthAzureStorage_getLastErrorXml(objHandle: HCkAuthAzureStorage; outPropVal: HCkString); stdcall;
function CkAuthAzureStorage__lastErrorXml(objHandle: HCkAuthAzureStorage): PWideChar; stdcall;

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

top
LastMethodSuccess
function CkAuthAzureStorage_getLastMethodSuccess(objHandle: HCkAuthAzureStorage): wordbool; stdcall;
procedure CkAuthAzureStorage_putLastMethodSuccess(objHandle: HCkAuthAzureStorage; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

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".

See the notes about PWideChar memory ownership and validity.

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".

Note: Authentication for the "Table" service did not work in versions prior to v9.5.0.83.

See the notes about PWideChar memory ownership and validity.

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 "10.1.0"

See the notes about PWideChar memory ownership and validity.

More Information and Examples
How to get the Chilkat version at runtime.
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".

See the notes about PWideChar memory ownership and validity.

top

Methods