adiStopMFDetector

Stops the MF detector.

Supported board types

Prototype

DWORD adiStopMFDetector ( CTAHD ctahd)

Argument	Description
ctahd	Context handle returned by ctaCreateContext or ctaAttachContext.

Return values

Return value	Description
SUCCESS
CTAERR_FUNCTION_NOT_ACTIVE	Attempt made to stop a function that was not running.
CTAERR_INVALID_CTAHD	Context handle is invalid.
CTAERR_INVALID_SEQUENCE	Attempt was made to stop a function that is already being stopped.
CTAERR_INVALID_STATE	Function not available in the current port state.
CTAERR_SVR_COMM	Server communication error.

Events

Event	Description
ADIEVN_MF_DETECT_DONE	After the detector stops, the ADI service generates a DONE event with the value field set to CTA_REASON_STOPPED.

Details

Use adiStopMFDetector to disable detection of MFs. After this function is called, MF events are not reported. When the DONE event is received, restart the MF detector with adiStartMFDetector.

Example

int myStopMFDetector( CTAHD ctahd )
{
  CTA_EVENT event;

  if( adiStopMFDetector( ctahd ) != SUCCESS )
      return MYFAILURE;

  while( 1 )
  {
      myGetEvent( &event );            /* see ctaWaitEvent example */

      switch( event.id )
      {
          case ADIEVN_MF_DETECT_DONE:
              if( event.value == CTA_REASON_RELEASED )
                  return MYDISCONNECT; /* call has been terminated */
              else if( CTA_IS_ERROR( event.value ) )
                  return MYFAILURE;                   /* API error */
              else
                  return SUCCESS;              /* stopped normally */
              break;
      }
  }
}