NMS_V5StopInterface

Stops a provisioned interface.

Prototype

NMS_V5_RESULT_T NMS_V5StopInterface ( NMS_GR303_INTERFACE_ID_T interfaceId)

Argument

Description

interfaceId

Interface ID of a provisioned interface.


Return values

Return value

Description

NMSV5_SUCCESS

 

NMSV5_INTERNAL_FAILURE

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

NMSV5_INVALID_INTERFACE_ID

Specified interface is not provisioned.

NMSV5_INVALID_STATE

Specified interface is not started.

NMSV5_NOT_INITIALIZED

NMS V5 library was not initialized with NMS_V5Initialize.


Details

NMS_V5StopInterface disables the HDLC channels and E1 links associated with the specified interface leaving the channels and links configured but inactive.

After stopping an interface, the application can restart the interface without re-provisioning it with NMS_V5StartInterface.

See also

NMS_V5DestroyInterface

Example

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

    printf("NMS_V5StopInterface:\n");
    /* Get parameters */
    promptdw_nodft("Enter InterfaceId", &InterfaceId);

    NmsResult = NMS_V5StopInterface( InterfaceId );

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