The TransferLineUri API procedure allows an application to transfer a currently active phone call to a new location as specified by a SIP URI. It is similar in functionality to the TransferLine(String, String, Int32, Int32) API procedure.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE TransferLineUri(
	string SipUri,
	bool UseProxy,
	int PhoneLine
)
Visual Basic (Declaration)
Public Function TransferLineUri ( _
	SipUri As String, _
	UseProxy As Boolean, _
	PhoneLine As Integer _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE TransferLineUri(
	String^ SipUri, 
	bool UseProxy, 
	int PhoneLine
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE TransferLineUri(
	String SipUri,
	boolean UseProxy,
	int PhoneLine
)

Parameters

SipUri
Type: System..::.String
The NULL terminated string specifying the call transfer location as a SIP URI. The basic form of an acceptable SIP URI is sip:user@host:port. At this time the media engine only processes user, host and port of SIP URIs. For a complete description of SIP URIs, please see section 19.1.1 (SIP and SIPS URI Components) of the SIP RFC (RFC3261).
UseProxy
Type: System..::.Boolean
If specified as non zero, then the call transfer command will be sent through your configured proxy server regardless of the destination address of the far end of the current phone call. The proxy will then be responsible for forwarding the transfer command to the far end of the current call.
PhoneLine
Type: System..::.Int32
The zero based telephony engine phone line that will be used to transfer the phone call.

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. The TransferLineUri API procedure returns the same values as specified by the TransferLine(String, String, Int32, Int32) API procedure in addition to the following return values:

Return ValueDescription
SipProxyNotEnabled
Indicates that an operation was attempted that requires a proxy server to be configured and enabled. However, proxy support has not yet been enabled.

(API return value)

Remarks

None.

See Also