AuthAzureStorage Unicode C Reference Documentation
AuthAzureStorage
Current Version: 10.1.2
Provides functionality for authenticating calls to Azure Storage Services.
Create/Dispose
HCkAuthAzureStorageW instance = CkAuthAzureStorageW_Create(); // ... CkAuthAzureStorageW_Dispose(instance);
Creates an instance of the HCkAuthAzureStorageW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
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
AccessKey
void CkAuthAzureStorageW_putAccessKey(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureStorageW_accessKey(HCkAuthAzureStorageW cHandle);
Account
void CkAuthAzureStorageW_putAccount(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureStorageW_account(HCkAuthAzureStorageW cHandle);
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. )
topDebugLogFilePath
void CkAuthAzureStorageW_putDebugLogFilePath(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureStorageW_debugLogFilePath(HCkAuthAzureStorageW cHandle);
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.
LastErrorHtml
const wchar_t *CkAuthAzureStorageW_lastErrorHtml(HCkAuthAzureStorageW cHandle);
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.
topLastErrorText
const wchar_t *CkAuthAzureStorageW_lastErrorText(HCkAuthAzureStorageW cHandle);
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.
LastErrorXml
const wchar_t *CkAuthAzureStorageW_lastErrorXml(HCkAuthAzureStorageW cHandle);
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.
topLastMethodSuccess
void CkAuthAzureStorageW_putLastMethodSuccess(HCkAuthAzureStorageW cHandle, BOOL newVal);
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.
topScheme
void CkAuthAzureStorageW_putScheme(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureStorageW_scheme(HCkAuthAzureStorageW cHandle);
Can be "SharedKey" or "SharedKeyLite". The default value is "SharedKey".
topService
void CkAuthAzureStorageW_putService(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureStorageW_service(HCkAuthAzureStorageW cHandle);
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.
topVerboseLogging
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.
topVersion
const wchar_t *CkAuthAzureStorageW_version(HCkAuthAzureStorageW cHandle);
XMsVersion
void CkAuthAzureStorageW_putXMsVersion(HCkAuthAzureStorageW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthAzureStorageW_xMsVersion(HCkAuthAzureStorageW cHandle);
If set, automatically adds the "x-ms-version" HTTP request header to Azure Storage requests. The default value is "2014-02-14".
top