NCM_GetDlgSrvState( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetDlgSrvState( pncmSrvState )
Inputs:	NCMDlgSrvState *pncmSrvState	pointer where Intel® Dialogic System Service state will be output
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetDlgSrvState( ) function gets the Intel® Dialogic System Service state. For more information about the Intel® Dialogic System Service, see Section 2.8, Starting and Stopping the Intel® Dialogic System Service.

This function returns the state of the Intel® Dialogic System Service by filling the passed pointer.

The function parameter is defined as follows:

Parameter	Description
pncmSrvState	points to the current state of the Intel® Dialogic System Service. Refer to the Windows* documentation for possible states of a service.

Cautions

None

Example

#include "NCMApi.h" 
...
//
// Execute
// 
NCMDlgSrvState           serviceState = 0;
NCMRetCode     ncmRc = NCM_GetDlgSrvState( &serviceState ); 
if ( ncmRc == NCM_SUCCESS )
{
     if ( serviceState == SERVICE_CONTINUE_PENDING )
     {
          printf( "Continue Pending\n" );
     }
     else if ( serviceState == SERVICE_PAUSE_PENDING )
     {
          printf( "Pause Pending\n" );
     }
     else if ( serviceState == SERVICE_STOP_PENDING )
     {
          printf( "Stop Pending\n" );
     }
     else if ( serviceState == SERVICE_START_PENDING )
     {
          printf( "Start Pending\n" );
     }
     else if ( serviceState == SERVICE_RUNNING )
     {
          printf( "Running\n" );
     }
     else if ( serviceState == SERVICE_STOPPED )
     {
          printf( "Stopped\n" );
     }
     else if ( serviceState == SERVICE_PAUSED )
     {
          printf( "Paused\n" );
     }
     else
     {
          printf( "Unknown\n" );
     }
}
else
{     // process error
     ...
}
... 

Error Codes

Equate	Returned When
NCME_OPENING_SCM	an error occurred opening service control manager
NCME_OPENING_DLGC_SVC	an error occurred opening the Intel® Dialogic System Service
NCME_QUERY_SVC_STATUS	an error occurred querying the status of the Intel® Dialogic System Service
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid

See Also

• NCM_GetDlgSrvStartupMode( )
• NCM_SetDlgSrvStartupMode( )
• NCM_StartDlgSrv( )
• NCM_StopDlgSrv( )

Click here to contact Telecom Support Resources