Cisco Cisco IOS Software Release 12.2(15)T Guide Du Développeur

TCP_WRITE_ERROR—A TCP write error was encountered. The application should call 
CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.

MEM_ALLOC_FAIL—Memory allocation failed.

TCP_CONNECTION_CLOSED—The connection to the Cisco IOS Gatekeeper has been closed. 
The application must call CloseGateKeeperConnection to free resources such as gkHandle in the 
GKAPI_SOCK_INFO structure.

INVALID_MSG_SPECIFIED—The message type is not within the RESPONSE_MSG_TYPE 
range.

INVALID_ENDPOINT_SPECIFIED—The endpoint does not match one of the possible values for 
ENDPOINT_TYPE.

INVALID_REDIRECT_REASON_SPECIFIED—The redirect reason does not match one of the 
possible values for REDIRECT_REASON_TYPE.

HEADER_INFO_INCOMPLETE—One of the fields in the header (To, From, TransactionID) is 
incomplete.

NULL_POINTER_PASSED—The pointer to the GK_REGISTER_MSG is null.

The following initialization values indicate that the parameter should not be sent to the 
Cisco IOS Gatekeeper for Registration, and the external application is not interested in these parameters:

REDIRECT_REASON_TYPE - REDIRECT_REASON_INFO_NOT_RCVD

ENDPOINT_TYPE - ENDPOINT_INFO_NOT_RCVD

This function sends an unregister message to the Cisco IOS Gatekeeper when the application no longer 
wants to receive a particular message. This structure contains 

, which is an 

enumeration of messages that can be unregistered with the Cisco IOS Gatekeeper.

The input for this function is:

A pointer to the 

 structure.

A pointer to the 

 structure, which contains the To, From, and Priority 

fields that must be filled in by the application. The msgType must be filled in to indicate which 
message needs to be unregistered.

The return for this function is the 

. Possible values for STATUS_TYPE are:

PROCESSING_SUCCESSFUL—No errors were encountered.

CONNECT_IN_PROGRESS—Connection is pending. The application should retry this API call 
after some time has passed.

TCP_WRITE_ERROR—A TCP write error was encountered. The application should call 
CloseGateKeeperConnection to close the connection to the Cisco IOS Gatekeeper.

MEM_ALLOC_FAIL—Memory allocation failed.