TChilkatAuthAzureSAS Delphi ActiveX Reference Documentation

TChilkatAuthAzureSAS

Current Version: 10.0.0

Requires Chilkat Bundle License

Provides general functionality for Azure Shared Access Signature (SAS) Authorization.

This class is introduced in Chilkat v9.5.0.65.

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).

Two things are required to use an ActiveX in Delphi:

The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
See also: ActiveX Registration Tutorial
The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
Check the "Generate Component Wrappers" checkbox.
Select a directory where the unit files (.pas and .dcr) should be generated.
Select "Create Unit" and then "Finish".
Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

Object Creation

var
obj: TChilkatAuthAzureSAS;
...
begin
obj := TChilkatAuthAzureSAS.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

AccessKey

property AccessKey: WideString

Introduced in version 9.5.0.65

This is the signing key (access key) that must be kept private. It is a base64 string such as "abdTvCZFFoWUyre6erlNN+IOb9qhXgDsyhrxmZvpmxqFDwpl9oD0X9Fy0hIQa6L5UohznRLmkCtUYySO4Y2eaw=="

More Information and Examples

How to Generate an Azure Service Bus Shared Access Signature (SAS)How to Generate an Azure Storage Account Shared Access Signature (SAS)

DebugLogFilePath

property DebugLogFilePath: WideString

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastBinaryResult

property LastBinaryResult: OleVariant readonly

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml

property LastErrorHtml: WideString readonly

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.

LastErrorText

property LastErrorText: WideString readonly

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

property LastErrorXml: WideString readonly

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.

LastMethodSuccess

property LastMethodSuccess: Integer

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult

property LastStringResult: WideString readonly

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

property LastStringResultLen: Integer readonly

The length, in characters, of the string contained in the LastStringResult property.

StringToSign

property StringToSign: WideString

Introduced in version 9.5.0.65

Defines the format of the string to sign.

The format is specified as a comma-separated list of names. For example:

signedpermissions,signedstart,signedexpiry,canonicalizedresource,signedidentifier,signedIP,signedProtocol,signedversion,rscc,rscd,rsce,rscl,rsct

This will result in an actual string-to-sign that is composed of the values for each name separated by newline (LF) chars. For example:

signedpermissions + "\n" +  
signedstart + "\n" +  
signedexpiry + "\n" +  
canonicalizedresource + "\n" +  
signedidentifier + "\n" +  
signedIP + "\n" +  
signedProtocol + "\n" +  
signedversion + "\n" +  
rscc + "\n" +  
rscd + "\n" +  
rsce + "\n" +  
rscl + "\n" +  
rsct

VerboseLogging

property VerboseLogging: Integer

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

property Version: WideString readonly

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

Clear

procedure Clear();

Introduced in version 9.5.0.65

Clears all params set by the methods SetNonTokenParam and SetTokenParam.

Returns 1 for success, 0 for failure.

GenerateToken

function GenerateToken(): WideString;

Introduced in version 9.5.0.65

Generates and returns the SAS token based on the defined StringToSign and params.

Returns a zero-length WideString on failure

More Information and Examples

How to Generate an Azure Service Bus Shared Access Signature (SAS)How to Generate an Azure Storage Account Shared Access Signature (SAS)Create an Azure Service SAS Use an Azure Service SAS

SetNonTokenParam

function SetNonTokenParam(name: WideString; value: WideString): Integer;

Introduced in version 9.5.0.65

Adds a non-token parameter name/value. This is a value that is included in the string to sign, but is NOT included as a parameter in the Authorization header.

Returns 1 for success, 0 for failure.

SetTokenParam

function SetTokenParam(name: WideString; authParamName: WideString; value: WideString): Integer;

Introduced in version 9.5.0.65

Adds a token parameter name/value. This is a value that is included in the string to sign, and is also included as a parameter in the Authorization header.

Returns 1 for success, 0 for failure.

More Information and Examples

Create an Azure Service SAS Use an Azure Service SAS