The SetPhoneDisplayName function allows you to change the "display name" of any phone line of the telephony engine. By default, the display name of each phone line is set when you call the StartSipTelephony(VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS) procedure. For most applications, phone line display names never need to be changed. There are application instances however that required that for a "specific call", the display name of the phone line be changed.

For additional information, see the remarks section below.

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

Syntax

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

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to configure.
PhoneDisplayName
Type: System..::.String
The null terminate string containing the display name of the telephony engine phone line.

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)

Remarks

Each phone line can be assigned a different display name. The display name you assign to any of the phone lines of the telephony engine can contain any of the following characters:

Hexidecimal Character RangeCharacters
0x20 space
0x21 !
0x23 - 0x3B #$%&'()*+,-./0123456789:;
0x3D =
0x3F - 0x5B ?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[
0x5D - 0x7E ]^_`abcdefghijklmnopqrstuvwxyz<|>>~

See Also