TwclTimelineChannel.RegisterProtocol(string,string) Method

Registers an Application Activation Protocol.

Namespace: wclTimeline
Delphi
public
 class function RegisterProtocol(const Protocol: string;
 const DisplayName: string): Integer;

Parameters

Protocol
Type: string

The string represents the unique idenfier for the Application Actiovation Protocol.

DisplayName
Type: string

The user friendly display name that describes the Application Activation protocol.

Return Value

Type: Integer

If the function succeed the return value is wclErrors.WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.

The Application Activation Protocol is a part of the Activation Deep Link, a URI that will be used to start your application to resume the application with specific context. It is used to activate your appliation when user selects activity from the Windows Timeline Graph.

The Application Activation Protocol must unique identifies your application and must not overwrite existing system protocol. An application can register more than one protocol.