The EnableSipDomain API procedure allows an application to specify the domain name of the telephony environment. You must call this API procedure prior to using any of the SIP proxy and/or SIP registrar services.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE EnableSipDomain(
	string SipDomainName
)
Visual Basic (Declaration)
Public Function EnableSipDomain ( _
	SipDomainName As String _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE EnableSipDomain(
	String^ SipDomainName
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE EnableSipDomain(
	String SipDomainName
)

Parameters

SipDomainName
Type: System..::.String
The string that contains the domain name of the telephony environment. Normally you would specify this string to be something like: "MyCompanyName.com".

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)

SipDomainError
A bad Sip domain name string was passed to the EnableSipDomain(String) API procedure.

(API return value)

Remarks

None.

See Also