The SetWanIpAddress function allows an application to specify a wide area network address (WAN) that will be used when communicating with other devices. Depending on your network infrastructure, this API procedure may have to be called by an application if the application resides on a private network and is behind one or more NAT routers and you intend to allow calls to be made to the global internet.

If your application has knowledge about its network infrastructure (NAT router placement and subnet configurations) this API procedure can be called prior to placing a phone call to ensure that the far end of the call will be able to communicate back to your application. If you are also deploying a LanScape proxy/registrar with your voice solution, you do not need to call this procedure.

If your application changes the Wan IP address of the media engine, your application will also receive the SipWanIpAddressChange event.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetWanIpAddress(
	string IpAddressStr
Visual Basic (Declaration)
Public Function SetWanIpAddress ( _
	IpAddressStr As String _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetWanIpAddress(
	String^ IpAddressStr
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetWanIpAddress(
	String IpAddressStr


Type: System..::.String
A string that specifies a dotted decimal IP address (i.e. ""). If your application wants to disable the use of a previously configured Wan IP address, specify a zero length string ("").

Return Value

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.

Return ValueDescription
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

One of the telephony API procedures was called by application software and was passed a pointer to an invalid memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API. For managed code applications, you should never see this error unless your process space has exhausted memory.

(API return value)



See Also