The IsUserNameRegistered procedure allows applications to query the media engine for the current registration state of a user name (phone line extension). Usually applications call this API procedure when processing the SipRegisterSuccess and SipUnRegisterSuccess events. It can however be called anytime.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE IsUserNameRegistered(
	string UserName,
	ref bool IsRegistered
Visual Basic (Declaration)
Public Function IsUserNameRegistered ( _
	UserName As String, _
	ByRef IsRegistered As Boolean _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE IsUserNameRegistered(
	String^ UserName, 
	bool% IsRegistered
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE IsUserNameRegistered(
	String UserName,
	/** @ref */boolean IsRegistered


Type: System..::.String
A string that contains the user name to test.
Type: System..::.Boolean %
The reference of a variable that will hold the return value.

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)

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)

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