AuthAzureStorage Unicode C++ Reference Documentation
CkAuthAzureStorageW
Current Version: 10.1.2
Provides functionality for authenticating calls to Azure Storage Services.
Object Creation
// Local variable on the stack CkAuthAzureStorageW obj; // Dynamically allocate/delete CkAuthAzureStorageW *pObj = new CkAuthAzureStorageW(); // ... delete pObj;
Properties
AccessKey
const wchar_t *accessKey(void);
void put_AccessKey(const wchar_t *str);
Account
const wchar_t *account(void);
void put_Account(const wchar_t *str);
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
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);
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
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
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
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 put_LastMethodSuccess(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
Can be "SharedKey" or "SharedKeyLite". The default value is "SharedKey".
topService
const wchar_t *service(void);
void put_Service(const wchar_t *str);
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 put_VerboseLogging(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
XMsVersion
const wchar_t *xMsVersion(void);
void put_XMsVersion(const wchar_t *str);
If set, automatically adds the "x-ms-version" HTTP request header to Azure Storage requests. The default value is "2014-02-14".
top