nn::nex::CallContext::Cancel Member Function

Syntax

qBool Cancel(
     State eNewState = CallCancelled
);

Parameters

Name Description
in eNewState The new State for this CallContext. The default value is CallCancelled.

Return Values

Returns true if the call was canceled without problem. If not, or if an error occurs, returns false. If the state of the asynchronous process is anything other than CallInProgress, calling this method results in the SYSTEMERROR_GEN_INVALID_OPERATION error.

Description

Cancels the asynchronous process associated with this CallContext.

If the asynchronous process call associated with this CallContext has not been issued yet, it is canceled. If it has been issued it cannot be canceled, so the asynchronous process result is simply ignored. As a result, the resource specified by the out argument set when starting asynchronous processing can be released.

This method can be called only when the state of the CallContext is CallInProgress.

After you use this function and cancel asynchronous processing, do not refer to the result of asynchronous processing.

See Also

State, Reset

Revision History

2011/01/27
Initial version.

CONFIDENTIAL