NMS_GR303StopInterface

Stops the physical layer (HDLC channels) of the provisioned interface.

Prototype

NMS_GR303_RESULT_T NMS_GR303StopInterface ( NMS_GR303_INTERFACE_ID_T interfaceId)

Argument

Description

interfaceId

Interface ID of a provisioned interface.


Return values

Return value

Description

NMSGR303_SUCCESS

 

NMSGR303_INTERNAL_FAILURE

Internal failure. Refer to the trace log for more information.

NMSGR303_INVALID_INTERFACE_ID

Specified interface is not provisioned.

NMSGR303_INVALID_STATE

Interface is already stopped.

NMSGR303_NOT_INITIALIZED

NMS GR303 library was not initialized with NMS_GR303Initialize.


Details

NMS_GR303StopInterface disables HDLC channels on a specified interface and leaves the channels configured but inactive. When the NMS GR303 library finishes executing this function, it no longer sends receive and transmit channel events to the application. After an interface is stopped, the application can restart the interface at any time without re-provisioning it.

See also

NMS_GR303StartInterface, NMS_GR303DestroyInterface

Example

void  StopInterface( void )
{
       NMS_GR303_RESULT_T NmsResult;
       DWORD              InterfaceId;

       printf("NMS_GR303StopInterface:\n");

       /* Get parameters */
       promptdw_nodft("Enter interfaceId", &InterfaceId);

       NmsResult = NMS_GR303StopInterface( InterfaceId );

       printf ("NMS_GR303StopInterface:
              Result=%s\n",PRINT_RESULT(NmsResult));
}