AuthAzureStorage C Reference Documentation
AuthAzureStorage
Current Version: 10.1.0
Provides functionality for authenticating calls to Azure Storage Services.
Create/Dispose
HCkAuthAzureStorage instance = CkAuthAzureStorage_Create(); // ... CkAuthAzureStorage_Dispose(instance);
Creates an instance of the HCkAuthAzureStorage 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 CkAuthAzureStorage_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 CkAuthAzureStorage_Dispose.
Properties
AccessKey
void CkAuthAzureStorage_putAccessKey(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_accessKey(HCkAuthAzureStorage cHandle);
Account
void CkAuthAzureStorage_putAccount(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_account(HCkAuthAzureStorage 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 CkAuthAzureStorage_putDebugLogFilePath(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_debugLogFilePath(HCkAuthAzureStorage 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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
const char *CkAuthAzureStorage_lastErrorHtml(HCkAuthAzureStorage 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.
topLastErrorText
const char *CkAuthAzureStorage_lastErrorText(HCkAuthAzureStorage 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.
LastErrorXml
const char *CkAuthAzureStorage_lastErrorXml(HCkAuthAzureStorage 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.
topLastMethodSuccess
void CkAuthAzureStorage_putLastMethodSuccess(HCkAuthAzureStorage cHandle, BOOL newVal);
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.
topScheme
void CkAuthAzureStorage_putScheme(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_scheme(HCkAuthAzureStorage cHandle);
Can be "SharedKey" or "SharedKeyLite". The default value is "SharedKey".
topService
void CkAuthAzureStorage_putService(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_service(HCkAuthAzureStorage 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.
topUtf8
void CkAuthAzureStorage_putUtf8(HCkAuthAzureStorage cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topVerboseLogging
void CkAuthAzureStorage_putVerboseLogging(HCkAuthAzureStorage 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 char *CkAuthAzureStorage_version(HCkAuthAzureStorage cHandle);
XMsVersion
void CkAuthAzureStorage_putXMsVersion(HCkAuthAzureStorage cHandle, const char *newVal);
const char *CkAuthAzureStorage_xMsVersion(HCkAuthAzureStorage cHandle);
If set, automatically adds the "x-ms-version" HTTP request header to Azure Storage requests. The default value is "2014-02-14".
top