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

When the media engine sends SIP protocol messages to other applications or devices, by default it will place the branch parameter in the outgoing SIP message.

The SIP branch parameter is used as a transaction identifier. Responses relating to a particular SIP request can be correlated to the original request because they will contain this same branch transaction identifier. SIP Branch parameters also allow proxies to match responses to forked requests.

The media engine adds the appropriate branch parameter to transmitted SIP messages by default. You should only call this API procedure if you absolutely know what you are doing and you want to override the default behavior.

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

Syntax

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

Parameters

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
SipCallFailure
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)

SipInvalidHandle
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)

Remarks

None.

See Also