AuthUtil Unicode C Reference Documentation

AuthUtil

Deprecated To be removed in a future version, and should no longer be used.
Current Version: 10.1.2
Requires Chilkat Bundle License

The AuthUtil class is intended to contain methods to help with authentication for various services, as the need arises. For example, the Walmart REST API requires an RSA signature calculation and this class provides a method for it.

Create/Dispose

HCkAuthUtilW instance = CkAuthUtilW_Create();
// ...
CkAuthUtilW_Dispose(instance);
HCkAuthUtilW CkAuthUtilW_Create(void);

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

void CkAuthUtilW_Dispose(HCkAuthUtilW handle);

Objects created by calling CkAuthUtilW_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 CkAuthUtilW_Dispose.

Properties

DebugLogFilePath
void CkAuthUtilW_getDebugLogFilePath(HCkAuthUtilW cHandle, HCkString retval);
void CkAuthUtilW_putDebugLogFilePath(HCkAuthUtilW cHandle, const wchar_t *newVal);
const wchar_t *CkAuthUtilW_debugLogFilePath(HCkAuthUtilW 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.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
void CkAuthUtilW_getLastErrorHtml(HCkAuthUtilW cHandle, HCkString retval);
const wchar_t *CkAuthUtilW_lastErrorHtml(HCkAuthUtilW 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.

top
LastErrorText
void CkAuthUtilW_getLastErrorText(HCkAuthUtilW cHandle, HCkString retval);
const wchar_t *CkAuthUtilW_lastErrorText(HCkAuthUtilW 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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
void CkAuthUtilW_getLastErrorXml(HCkAuthUtilW cHandle, HCkString retval);
const wchar_t *CkAuthUtilW_lastErrorXml(HCkAuthUtilW 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.

top
LastMethodSuccess
BOOL CkAuthUtilW_getLastMethodSuccess(HCkAuthUtilW cHandle);
void CkAuthUtilW_putLastMethodSuccess(HCkAuthUtilW 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.

top
VerboseLogging
BOOL CkAuthUtilW_getVerboseLogging(HCkAuthUtilW cHandle);
void CkAuthUtilW_putVerboseLogging(HCkAuthUtilW 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.

top
Version
void CkAuthUtilW_getVersion(HCkAuthUtilW cHandle, HCkString retval);
const wchar_t *CkAuthUtilW_version(HCkAuthUtilW cHandle);

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

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

WalmartSignature
BOOL CkAuthUtilW_WalmartSignature(HCkAuthUtilW cHandle, const wchar_t *requestUrl, const wchar_t *consumerId, const wchar_t *privateKey, const wchar_t *requestMethod, const wchar_t *outStr);
const wchar_t *CkAuthUtilW_walmartSignature(HCkAuthUtilW cHandle, const wchar_t *requestUrl, const wchar_t *consumerId, const wchar_t *privateKey, const wchar_t *requestMethod);
Introduced in version 9.5.0.67

Note: The Walmart REST API no longer users signatures for authentication. OAuth is now used. This method is deprecated and should no longer be used.

Generates a Walmart authentication signature for Walmart REST API calls. Returns a JSON string that contains both the WM_SEC_AUTH_SIGNATURE and WM_SEC.TIMESTAMP.

Returns TRUE for success, FALSE for failure.

More Information and Examples
Walmart - Get All Feed Statuses
top