Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 6 of 14 in this chapter) Version

mspDestroyEndpoint

Description

Destroys a specified MSPP endpoint.

Prototype

DWORD mspDestroyEndpoint (MSPHD ephd)
ephd MSPP endpoint handle.

Return Values

SUCCESS
CTAERR_BAD_ARGUMENT
The function argument had an invalid value or a required pointer argument was NULL.
CTAERR_INVALID_CTAHD
The CTA context handle is invalid.
CTAERR_INVALID_HANDLE
An invalid handle was passed as an argument to this function.
MSPERR_INVALID_HANDLE
The specified MSPP endpoint is not valid.
MSPERR_DRIVER_COMMAND_FAILED
An SPI command has failed.
MSPERR_ENDPOINT_NOT_ALLOCATED
The MSPP endpoint is defined, but not yet allocated on the board.

Events

MSPEVN_DESTROY_ENDPOINT_DONE
Generated when an MSPP endpoint is destroyed following a call to mspDestroyEndpoint. The event.value field can contain the following:
SUCCESS
MSPRSN_FAILED_TO_DEALLOCATE
The MSPP service is unable to deallocate on-board
resources.

Details

When called, mspDestroyEndpoint removes a specified MSPP endpoint, as well as disables and disconnects the associated connection, if applicable.

See Also

mspCreateEndpoint

Example


ret = mspDestroyEndpoint(hEp);
if (ret != SUCCESS)
    return FAILURE;
// Wait for event
ctaWaitEvent( hCta, &Event, CTA_WAIT_FOREVER );
// Check the reason code
if ( Event.id    != MSPEVN_DESTROY_ENDPOINT_DONE ||
     Event.value != CTA_REASON_FINISHED )
    return FAILURE;

Table of Contents

Index

NMS Glossary

Previous Page

Next Page

(Page 6 of 14 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com

Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.