AuthAzureAD Delphi DLL Reference Documentation

AuthAzureAD

Current Version: 9.5.0.97

Provides functionality for obtaining an Azure AD access token via OAuth2 for Service to Service Calls Using Client Credentials. (See https://msdn.microsoft.com/en-us/library/dn645543.aspx)

Create/Dispose

var
myObject: HCkAuthAzureAD;

begin
myObject := CkAuthAzureAD_Create();

// ...

CkAuthAzureAD_Dispose(myObject);
end;
function CkAuthAzureAD_Create: HCkAuthAzureAD; stdcall;

Creates an instance of the HCkAuthAzureAD 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 CkAuthAzureAD_Dispose(handle: HCkAuthAzureAD); stdcall;

Objects created by calling CkAuthAzureAD_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AccessToken
procedure CkAuthAzureAD_getAccessToken(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putAccessToken(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;
function CkAuthAzureAD__accessToken(objHandle: HCkAuthAzureAD): PWideChar; stdcall;
Introduced in version 9.5.0.58

The access token to be used in Azure AD REST API requests. This property is set on a successful call to ObtainAccessToken.

More Information and Examples
top
ClientId
procedure CkAuthAzureAD_getClientId(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putClientId(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;
function CkAuthAzureAD__clientId(objHandle: HCkAuthAzureAD): PWideChar; stdcall;
Introduced in version 9.5.0.58

Specifies the Azure AD client id of the calling web service. To find the calling application's client ID, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
ClientSecret
procedure CkAuthAzureAD_getClientSecret(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putClientSecret(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;
function CkAuthAzureAD__clientSecret(objHandle: HCkAuthAzureAD): PWideChar; stdcall;
Introduced in version 9.5.0.58

A key registered for the calling web service in Azure AD. To create a key, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
DebugLogFilePath
procedure CkAuthAzureAD_getDebugLogFilePath(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putDebugLogFilePath(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;
function CkAuthAzureAD__debugLogFilePath(objHandle: HCkAuthAzureAD): 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 CkAuthAzureAD_getLastErrorHtml(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
function CkAuthAzureAD__lastErrorHtml(objHandle: HCkAuthAzureAD): 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 CkAuthAzureAD_getLastErrorText(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
function CkAuthAzureAD__lastErrorText(objHandle: HCkAuthAzureAD): 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 CkAuthAzureAD_getLastErrorXml(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
function CkAuthAzureAD__lastErrorXml(objHandle: HCkAuthAzureAD): 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 CkAuthAzureAD_getLastMethodSuccess(objHandle: HCkAuthAzureAD): wordbool; stdcall;
procedure CkAuthAzureAD_putLastMethodSuccess(objHandle: HCkAuthAzureAD; newPropVal: wordbool); stdcall;

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
NumSecondsRemaining
function CkAuthAzureAD_getNumSecondsRemaining(objHandle: HCkAuthAzureAD): Integer; stdcall;
Introduced in version 9.5.0.58

If the access token is valid, contains the number of seconds remaining until it expires. A value of 0 indicates an invalid or expired access token.

top
Resource
procedure CkAuthAzureAD_getResource(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putResource(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;
function CkAuthAzureAD__resource(objHandle: HCkAuthAzureAD): PWideChar; stdcall;
Introduced in version 9.5.0.58

The App ID URI of the receiving web service. To find the App ID URI, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
TenantId
procedure CkAuthAzureAD_getTenantId(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
procedure CkAuthAzureAD_putTenantId(objHandle: HCkAuthAzureAD; newPropVal: PWideChar); stdcall;
function CkAuthAzureAD__tenantId(objHandle: HCkAuthAzureAD): PWideChar; stdcall;
Introduced in version 9.5.0.58

Your Azure account tenant ID. (If you don't know what it is, Google "how to find my azure tenant id" for help.)

top
Valid
function CkAuthAzureAD_getValid(objHandle: HCkAuthAzureAD): wordbool; stdcall;
Introduced in version 9.5.0.58

True if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

top
VerboseLogging
function CkAuthAzureAD_getVerboseLogging(objHandle: HCkAuthAzureAD): wordbool; stdcall;
procedure CkAuthAzureAD_putVerboseLogging(objHandle: HCkAuthAzureAD; 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 CkAuthAzureAD_getVersion(objHandle: HCkAuthAzureAD; outPropVal: HCkString); stdcall;
function CkAuthAzureAD__version(objHandle: HCkAuthAzureAD): PWideChar; stdcall;

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

More Information and Examples
top

Methods

LoadTaskCaller
function CkAuthAzureAD_LoadTaskCaller(objHandle: HCkAuthAzureAD;
    task: HCkTask): wordbool; stdcall;
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

top
ObtainAccessToken
function CkAuthAzureAD_ObtainAccessToken(objHandle: HCkAuthAzureAD;
    connection: HCkSocket): wordbool; stdcall;
Introduced in version 9.5.0.58

Sends the HTTP request to fetch the access token. When this method completes successfully, the access token is available in the AccessToken property. The connection is an existing connection to login.microsoftonline.com.

Returns True for success, False for failure.

More Information and Examples
top
ObtainAccessTokenAsync (1)
function CkAuthAzureAD_ObtainAccessTokenAsync(objHandle: HCkAuthAzureAD;
    connection: HCkSocket): HCkTask; stdcall;
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

top

Events

Chilkat supports event callbacks for the Delphi DLL starting in version 9.5.0.82.

AbortCheck
function MyAbortCheck(): Integer; cdecl;
Introduced in version 9.5.0.82

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return True to abort; return False to continue (not abort)

More Information and Examples
top
PercentDone
function MyPercentDone(pctDone: Integer): Integer; cdecl;
Introduced in version 9.5.0.82

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

Return True to abort; return False to continue (not abort)

More Information and Examples
top
ProgressInfo
procedure MyProgressInfo(name: PWideChar; value: PWideChar) cdecl;
Introduced in version 9.5.0.82

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

More Information and Examples
top
TaskCompleted
procedure MyTaskCompleted(task: HCkTask) cdecl;
Introduced in version 9.5.0.82

Called in the background thread when an asynchronous task completes.

top