AuthUtil Delphi DLL Reference Documentation

AuthUtil

Current Version: 9.5.0.75

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

var
myObject: HCkAuthUtil;

begin
myObject := CkAuthUtil_Create();

// ...

CkAuthUtil_Dispose(myObject);
end;
function CkAuthUtil_Create: HCkAuthUtil; stdcall;

Creates an instance of the HCkAuthUtil object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkAuthUtil_Dispose(handle: HCkAuthUtil); stdcall;

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.

Properties

DebugLogFilePath
procedure CkAuthUtil_getDebugLogFilePath(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
procedure CkAuthUtil_putDebugLogFilePath(objHandle: HCkAuthUtil; newPropVal: PWideChar); stdcall;
function CkAuthUtil__debugLogFilePath(objHandle: HCkAuthUtil): PWideChar; stdcall;

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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
procedure CkAuthUtil_getLastErrorHtml(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
function CkAuthUtil__lastErrorHtml(objHandle: HCkAuthUtil): PWideChar; stdcall;

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
LastErrorText
procedure CkAuthUtil_getLastErrorText(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
function CkAuthUtil__lastErrorText(objHandle: HCkAuthUtil): PWideChar; stdcall;

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
LastErrorXml
procedure CkAuthUtil_getLastErrorXml(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
function CkAuthUtil__lastErrorXml(objHandle: HCkAuthUtil): PWideChar; stdcall;

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
LastMethodSuccess
function CkAuthUtil_getLastMethodSuccess(objHandle: HCkAuthUtil): wordbool; stdcall;
procedure CkAuthUtil_putLastMethodSuccess(objHandle: HCkAuthUtil; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

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
VerboseLogging
function CkAuthUtil_getVerboseLogging(objHandle: HCkAuthUtil): wordbool; stdcall;
procedure CkAuthUtil_putVerboseLogging(objHandle: HCkAuthUtil; newPropVal: wordbool); stdcall;

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
procedure CkAuthUtil_getVersion(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
function CkAuthUtil__version(objHandle: HCkAuthUtil): PWideChar; stdcall;

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

top

Methods

SaveLastError
function CkAuthUtil_SaveLastError(objHandle: HCkAuthUtil;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
WalmartSignature
function CkAuthUtil_WalmartSignature(objHandle: HCkAuthUtil;
    requestUrl: PWideChar;
    consumerId: PWideChar;
    privateKey: PWideChar;
    requestMethod: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkAuthUtil__walmartSignature(objHandle: HCkAuthUtil;
    requestUrl: PWideChar;
    consumerId: PWideChar;
    privateKey: PWideChar;
    requestMethod: PWideChar): PWideChar; stdcall;
Introduced in version 9.5.0.67

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
top