HandleToken

Called whenever a token is published by the GroupWise client. The token is then passed as a parameter.This is the heart of the TPH process. By evaluating the token parameter, you can determine what token was published as well as any token related data in the token structure. This function must be exported as ordinal value 6 (six).

Syntax

int WINAPI HandleToken ( 
   LPTPH_RETURNVAL lpTokenData 
   HWND hLinkWnd, 
   WORD msg );

Parameters

lpData

A LPTPH_RETURNVAL structure contains two members. The first member is a pointer to an LPMAC_TOKEN structure. This structure contains the token ID and parameter data. The second member is a pointer to an LPMAC_RETURNVAL structure. This structure is used for return values from value-returning tokens.

hLinkWnd

Handle to the link window.

msg

Link window execute message.

Return Values

The following values can be returned.

DLL_HAN_NOT_HANDLED

The token was not processed.

DLL_HAN_NO_ERROR

The token was processed. This value should be returned to block a token.

DLL_HAN_NOT_FOUND

The token resulted in a GroupWise "not found" condition.

DLL_HAN_CANCEL

The user cancelled the function.

DLL_HAN_TOKEN_ERROR

The token was not valid.

DLL_HAN_PARM_ERROR

One or more of the parameters were invalid.

Example

int WINAPI HandleToken(LPTPH_RETURNVAL lpTokenData, HWND hLinkWnd, WORD msg )
{
     return DLL_HAN_NOT_HANDLED;
}

Remarks

HandleToken( ) is called using ordinal value 6 (six).