The SetFromHeaderUserName API procedure can be called by application software to specify a temporary "username" that will appear in the SIP "From" header field of a transmitted INVITE message when making the next outgoing call using the MakeCall(String, String, UInt32, Int32, Boolean, UInt32) or MakeCallUri(String, Boolean, Int32, Boolean, UInt32) API procedures.

This capability is useful if an application wants to call various voice mail boxes of a voicemail server without having to change the phone name for all phone lines. In this case, the username of the SIP "from" header can be temporarily modified a single time for the outgoing call so that the voicemail server can determine what voicemail box to access.

When the call is terminated, the default phone name will be used in subsequent SIP "From:" header fields and calls for the phone line.

Note:
This API procedure must be called prior to calling either the MakeCall(String, String, UInt32, Int32, Boolean, UInt32) or MakeCallUri(String, Boolean, Int32, Boolean, UInt32) API procedure in order for it to take effect.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetFromHeaderUserName(
	int PhoneLine,
	string FromHeaderUserName
)
Visual Basic (Declaration)
Public Function SetFromHeaderUserName ( _
	PhoneLine As Integer, _
	FromHeaderUserName As String _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetFromHeaderUserName(
	int PhoneLine, 
	String^ FromHeaderUserName
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetFromHeaderUserName(
	int PhoneLine,
	String FromHeaderUserName
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based telephony engine phone line.
FromHeaderUserName
Type: System..::.String
The null terminated string for the new "From:" header user name.

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)

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

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