NAME

GRPC_GET_FAILED_SESSIONID - Get session ID that failed for calls.

SYNOPSIS

INTEGER FUNCTION GRPC_GET_FAILED_SESSIONID(SID)

ARGUMENTS

INTEGER SID
The session ID

DESCRIPTION

The GRPC_GET_FAILED_SESSIONID() function returns the session ID associated with the most recent GRPC_SESSION_FAILED error. This provides additional error information on a specific session ID that failed for calls that deal with sets of session IDs, either implicitly, such as GRPC_WAIT_ALL(), or explicitly, such as grpc_wait_and().

When there are more than two failed sessions, this function will return the session ID one by one. To make sure that all the failed sessions are handled, users have to call this function repeatedly until it returns GRPC_SESSIONID_VOID.

This function is MT-safe.

RETURN VALUE

If successful, GRPC_NO_ERROR is returned. In the case of an error, Error code is returned.

ERRORS

GRPC_NOT_INITIALIZED
GRPC client is not initialized yet.
GRPC_OTHER_ERROR_CODE
Internal error detected.
last update : $Date$