Removes an endpoint from the MGCP service registry.

DWORD mgcUnregisterEndpoint (CTAHD ctahd,
char *epname)

ctahd Context handle associated with the gateway application.

epname Pointer to an ASCII character string associated with a registered MGCP endpoint. Use the * wild card character to specify multiple endpoints.

• SUCCESS
• CTAERR_INVALID_CTAHD
  The specified context handle is invalid.
• CTAERR_INVALID_STATE
  The specified endpoint does not exist in the MGCP service registry.
• MGCERR_BAD_ENDPOINT
  The specified epname is not the name of a valid MGCP endpoint.
• MGCERR_NOT_GW_HANDLE
  The specified ctahd is not the handle associated with the application.

• MGCEVN_UNREGISTER_ENDPOINT_DONE
  The process of unregistering the MGCP endpoint has ended. This event can return the following reasons:
• CTA_REASON_FINISHED
  All endpoints are successfully unloaded.
• MGC_REASON_EP_DONE
  The process of unregistering the MGCP endpoint is
  complete for one of the specified MGCP endpoints.
  However, the MGCP service is still in the process of
  unregistering other endpoints that are referenced by
  wild cards.
• MGC_REASON_MSP_ENDPOINT_FAILED
  The MGCP service cannot destroy the MSPP
  endpoint associated with the specified MGCP
  endpoint.

This function removes an endpoint from the MGCP service registry. If a call agent then directs a request to this endpoint, the MGCP indicates that the endpoint does not exist.

Any activity in progress for the endpoint when the application calls mgcUnregisterEndpoint (for example, an active call) is immediately interrupted. If the endpoint is in service at the time of the call, it also generates a RestartInProgress command to the call agent, informing the call agent that the endpoint was taken out of service.

When specifying the epname argument, applications can use the * wild card to unregister multiple endpoints at a once.

Whenever possible, explicitly take endpoints out of service with mgcSetEndpointServiceState before unregistering them

char   epName[20]; // endpoint name

strcpy(epName,"DS001");

// Unregister endpoint with MGCP Service
ret = mgcUnregisterEndpoint (GWctahd, epName);
// GWctahd = CTA Handle returned from ctaCreateContext
// for the application
if (ret != SUCCESS)
{
 printf ("UnRegisterEndpoint %s returned error 0x%x\n", epName, ret);
}

// Now wait for done event
ctaWaitEvent( ctaquehd, &event, CTA_WAIT_FOREVER );
  
// Check the reason code
if ( event.id != MGCEVN_UNREGISTER_ENDPOINT_DONE ||
event.value != CTA_REASON_FINISHED)
{
 printf("mgcUnregisterEndpoint() %s event failed, REASON=%x", epName, event.value);
 return FAILURE;
}

mgcRegisterEndpoint, mgcSetEndpointServiceState