NMS_V5DestroyInterface

Destroys both active and standby variants of a specified interface.

Prototype

NMS_V5_RESULT_T NMS_V5DestroyInterface ( NMS_V5_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_NOT_INITIALIZED

NMS V5 library was not initialized with NMS_V5Initialize.


Details

NMS_V5DestroyInterface internally destroys all on-board connections for the HDLC channels and E1 links associated with the active variant, and clears any internal structures allocated for the specified interface for both active and standby variants.

Applications must stop the interface (with NMS_V5StopInterface) before invoking NMS_V5DestroyInterface, and must invoke NMS_V5DestroyInterface before re-provisioning the interface with NMS_V5ProvisionInterface.

See also

NMS_V5DestroyStandByVariant

Example

void  DestroyInterface( void )
{
    NMS_V5_RESULT_TNmsResult;
    DWORD          InterfaceId;

    printf("NMS_V5DestroyInterface:\n");

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

    NmsResult = NMS_V5DestroyInterface( InterfaceId );

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