AuthAzureStorage Unicode C Reference Documentation

AuthAzureStorage

Provides functionality for authenticating calls to Azure Storage Services.

Create/Dispose

HCkAuthAzureStorageW CkAuthAzureStorageW_Create(void);

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

void CkAuthAzureStorageW_Dispose(HCkAuthAzureStorageW handle);

Objects created by calling CkAuthAzureStorageW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkAuthAzureStorageW_Dispose.

Properties

void CkAuthAzureStorageW_getAccessKey(HCkAuthAzureStorageW cHandle, HCkString retval);

void CkAuthAzureStorageW_putAccessKey(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAzureStorageW_accessKey(HCkAuthAzureStorageW cHandle);

Introduced in version 9.5.0.58

A valid base64 access key for the Azure storage account.

Azure Storage Blob Simple Upload

void CkAuthAzureStorageW_getAccount(HCkAuthAzureStorageW cHandle, HCkString retval);

void CkAuthAzureStorageW_putAccount(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAzureStorageW_account(HCkAuthAzureStorageW cHandle);

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

void CkAuthAzureStorageW_getDebugLogFilePath(HCkAuthAzureStorageW cHandle, HCkString retval);

void CkAuthAzureStorageW_putDebugLogFilePath(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAzureStorageW_debugLogFilePath(HCkAuthAzureStorageW cHandle);

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.

void CkAuthAzureStorageW_getLastErrorHtml(HCkAuthAzureStorageW cHandle, HCkString retval);

const wchar_t *CkAuthAzureStorageW_lastErrorHtml(HCkAuthAzureStorageW cHandle);

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.

void CkAuthAzureStorageW_getLastErrorText(HCkAuthAzureStorageW cHandle, HCkString retval);

const wchar_t *CkAuthAzureStorageW_lastErrorText(HCkAuthAzureStorageW cHandle);

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.

Concept of LastErrorText

LastErrorText Standard Information

void CkAuthAzureStorageW_getLastErrorXml(HCkAuthAzureStorageW cHandle, HCkString retval);

const wchar_t *CkAuthAzureStorageW_lastErrorXml(HCkAuthAzureStorageW cHandle);

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.

BOOL CkAuthAzureStorageW_getLastMethodSuccess(HCkAuthAzureStorageW cHandle);

void CkAuthAzureStorageW_putLastMethodSuccess(HCkAuthAzureStorageW cHandle, BOOL newVal);

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.

void CkAuthAzureStorageW_getScheme(HCkAuthAzureStorageW cHandle, HCkString retval);

void CkAuthAzureStorageW_putScheme(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAzureStorageW_scheme(HCkAuthAzureStorageW cHandle);

Introduced in version 9.5.0.58

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

void CkAuthAzureStorageW_getService(HCkAuthAzureStorageW cHandle, HCkString retval);

void CkAuthAzureStorageW_putService(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAzureStorageW_service(HCkAuthAzureStorageW cHandle);

Introduced in version 9.5.0.58

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

BOOL CkAuthAzureStorageW_getVerboseLogging(HCkAuthAzureStorageW cHandle);

void CkAuthAzureStorageW_putVerboseLogging(HCkAuthAzureStorageW cHandle, BOOL newVal);

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.

void CkAuthAzureStorageW_getVersion(HCkAuthAzureStorageW cHandle, HCkString retval);

const wchar_t *CkAuthAzureStorageW_version(HCkAuthAzureStorageW cHandle);

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

void CkAuthAzureStorageW_getXMsVersion(HCkAuthAzureStorageW cHandle, HCkString retval);

void CkAuthAzureStorageW_putXMsVersion(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);

const wchar_t *CkAuthAzureStorageW_xMsVersion(HCkAuthAzureStorageW cHandle);

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

Methods

BOOL CkAuthAzureStorageW_SaveLastError(HCkAuthAzureStorageW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.