The UseRportInViaHeader API procedure can be called by application software to enable or disable the use of the "rport" parameter in the top most Via header that is contained in media engine SIP messages.

When the media engine sends SIP protocol messages to other applications or devices, placing this parameter in the via header allows the far end server to send responses back to where the SIP message originated from regardless of network address translation or port translation issues. This special function exists in an effort to overcome connectivity issued related to network address translation and port translation used in routers and firewalls.

The return value that servers assign to the rport parameter is also used by the media engine to detect if port translation is being performed. If you disable the use of the rport parameter, automatic NAT detection capabilities of the media engine will not function.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE UseRportInViaHeader(
	bool EnableState
Visual Basic (Declaration)
Public Function UseRportInViaHeader ( _
	EnableState As Boolean _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE UseRportInViaHeader(
	bool EnableState
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE UseRportInViaHeader(
	boolean EnableState


Type: System..::.Boolean
Allows application software to enable or disable this feature. Set to a non zero value to enable this feature.

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)

Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)



See Also