Stops the specified MSPP channel from processing data.

DWORD mspDisableChannel (MSPHD chnhd)

chnhd MSPP channel handle.

• 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_INTERNAL_HANDLE
  The specified MSPP channel is not valid.
• MSPERR_INVALID_HANDLE
  The specified MSPP channel is not valid.
• MSPERR_DRIVER_COMMAND_FAILED
  An SPI command has failed.
• MSPERR_CHANNEL_NOT_CONNECTED
  The specified MSPP channel is not connected to any endpoints.

• MSPEVN_DISABLE_CHANNEL_DONE
  Generated when the flow of data through an MSPP channel is stopped in response to an mspDisableChannel function call. The event.value field can contain the following:
• SUCCESS
• MSPRSN_FAILED_TO_STOP
  The MSPP service is unable to stop the on-board
  resource.

When called, mspDisableChannel discontinues the flow of all data that is sent through the specified MSPP channel.

mspCreateChannel, mspDestroyChannel, mspEnableChannel

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