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
ResultSuccess Process was successful.
ResultNotInitialized The library is not initialized. Execute the nn::uds::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. The released receive buffer can be re-used with the Attach function, but note that the application will only be able to access it after the Finalize function is executed.

Revision History

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