1
Download VeriCall Edge Function Reference Manual
Transcript
Trinity Convergence
VeriCall Edge Function Reference Manual
VE_NATCancelDiscover
Syntax:
t_ve_return_code_e
VE_NATCancelDiscover(
UWord32 ve_application_id )
Arguments:
ve_application_id
The registered application ID.
Returns:
An enumerated return code indicating success (VE_RETURN_CODE_SUCCESS) or an
error code. The returned enumeration type, t_ve_return_code_e, is described in
Appendix B.72 on Page 510. Descriptions of all the available VeriCall Edge
return/error codes is provided in Table A.1 on Page 245.
See Also:
None
Description:
VE_NATCancelDiscover is used to cancel the current NAT discovery operation
previously started using VE_NATStartDiscover.
The cancelled operation will result in a VE_USER_MSG_NAT_REQUEST_FAILED
event occurring. It should be noted that there is a possibility that the discover
operation completes before the cancel request is acted upon in which case the resulting
VE_USER_MSG_NAT_DISCOVER_RESPONSE event can simply be ignored.
The ve_application_id argument must be a valid registered application identifier.
Example:
This example shows how to cancel NAT discovery:
#include <ve_nat_prototypes.h>
/* Cancel current NAT discovery background task */
{
t_ve_return_code_e ret_code;
ret_code = VE_NATCancelDiscover(application_id);
}
if(ret_code != VE_RETURN_CODE_SUCCESS)
{
/* Handle error */
}
Trinity Convergence Confidential
Chapter 9: VeriCall Edge™ NAT API
231
