AuthUtil C Reference Documentation
Current Version: 22.214.171.124
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.
HCkAuthUtil instance = CkAuthUtil_Create(); // ... CkAuthUtil_Dispose(instance);
Creates an instance of the HCkAuthUtil 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 CkAuthUtil_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 CkAuthUtil_Dispose.
void CkAuthUtil_putDebugLogFilePath(HCkAuthUtil cHandle, const char *newVal);
const char *CkAuthUtil_debugLogFilePath(HCkAuthUtil 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.
const char *CkAuthUtil_lastErrorHtml(HCkAuthUtil 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.top
const char *CkAuthUtil_lastErrorText(HCkAuthUtil 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.top
const char *CkAuthUtil_lastErrorXml(HCkAuthUtil 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.top
void CkAuthUtil_putLastMethodSuccess(HCkAuthUtil 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.top
void CkAuthUtil_putUtf8(HCkAuthUtil 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.top
void CkAuthUtil_putVerboseLogging(HCkAuthUtil 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
const char *CkAuthUtil_version(HCkAuthUtil cHandle);
Version of the component/library, such as "126.96.36.199"top
Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.
Returns TRUE for success, FALSE for failure.top
const char *CkAuthUtil_walmartSignature(HCkAuthUtil cHandle, const char *requestUrl, const char *consumerId, const char *privateKey, const char *requestMethod);