imgtStop

Stops a management session initiated with imgtStart.

Prototype

DWORD imgtStop ( CTAHD ctahd )

Argument

Description

ctahd

Context handle returned by ctaCreateContext.


Return values

Return value

Description

SUCCESS

 

CTAERR_INVALID_HANDLE

The specified context handle is invalid.


Events

Event

Description

IMGTEVN_RCV_MESSAGE

An IMGT message with the code IMGT_STOPPED is returned in response to imgtStop. The message status field contains SUCCESS. This message indicates that the management session has been stopped.


Example

void ResetimgtConfiguration( CTAHD ctahd )
{
   DWORD ret;
   char *errortext="";

   /* stop receiving any events on the appropriate context */
   ret =           imgtStop( ctahd );
   
   if (ret != SUCCESS)
   {
          ctaGetText( ctahd, ret, (char *) errortext, 40);
          printf( "imgtStop failure: %s\n",errortext );
          exit( 1 );
   }
   /* wait for IMGTEVN_RCV_MESSAGE */
   ...

}

See Also

imgtStart