AuthUtil Delphi DLL 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

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, 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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
procedure CkAuthUtil_getLastErrorHtml(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
function CkAuthUtil__lastErrorHtml(objHandle: HCkAuthUtil): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

top
LastErrorText
procedure CkAuthUtil_getLastErrorText(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
function CkAuthUtil__lastErrorText(objHandle: HCkAuthUtil): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
procedure CkAuthUtil_getLastErrorXml(objHandle: HCkAuthUtil; outPropVal: HCkString); stdcall;
function CkAuthUtil__lastErrorXml(objHandle: HCkAuthUtil): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

top
LastMethodSuccess
function CkAuthUtil_getLastMethodSuccess(objHandle: HCkAuthUtil): wordbool; stdcall;
procedure CkAuthUtil_putLastMethodSuccess(objHandle: HCkAuthUtil; newPropVal: wordbool); stdcall;

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
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 "10.1.0"

See the notes about PWideChar memory ownership and validity.

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

Methods

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

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples
Walmart - Get All Feed Statuses
top