nn::http::Connection::Cancel Member Function

Syntax

nn::Result Cancel(
     void
);

Arguments

None.

Return Values

Returns the function's execution result. Returns a Result listed below.
Value Description
ResultSuccess Process was successful.
ResultNotConnectedErr Error indicating a Connection class instance for which the target URL is not assigned. The function has not done anything as it has been called on a Connection instance for which you have not yet successfully called Initialize.
ResultNotInitializedErr Error indicating that the library is not initialized. None of this library's functions can be used until you first call nn::http::Initialize.
A value other than the above. Unexpected error (See http_Result.h for details).

Description

Cancels the connection. The function does nothing and returns ResultSuccess when the connection has already been closed (including due to an error) or has already been canceled.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL