nn::uds::CTR::DestroyEndpoint Function

Syntax

nn::Result DestroyEndpoint(
     EndpointDescriptor * pEndpointDesc
);

Arguments

Name Description
in pEndpointDesc Descriptor indicating the endpoint.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Process was successful.
ResultNotInitialized The library is not initialized. Execute the Initialize function.
ResultNotAuthorized Returns that an invalid EndpointDescriptor was specified.
A value other than the above Failed for reasons other than those given above.

Description

Destroys an endpoint.

When an endpoint for which the Attach function has been executed is specified, the receive buffer is released. Although the released recieve buffer can be used again by using Attach, the application can only access it after Finalize executes. This function is thread-safe.

Revision History

2011/03/08
Added a link to Initialize in Return Values.
2010/10/15
Expanded the information on the return values. Revised the Description to make it easier to understand.
2010/06/14
Initial version.

CONFIDENTIAL