The SipTelephonyEnable function is used after an instance of the telephony engine is created and after all
configuration API procedures have been executed. Calling SipTelephonyEnable allows the telephony engine to
accept incoming SIP traffic. It also allows you to make out bound calls. You must call this API procedure
in order to initiate or receive voice over IP phone calls.
Namespace:
LanScapeNote: |
---|
If you require domain, proxy or registrar support, you must call this API procedure prior to using domain, proxy or registrar APIs. For further information, see "How to enable Domain, Proxy and Registrar support in the Software Developer's Reference". |
Note: |
---|
If you want to subscribe to events offered by another telephony device, you must call the StartEventSubscription(VoipMediaEngine, String, String, String, UInt32, Boolean, String, String, UInt32, UInt32, UInt32) API procedure after calling this SIpTelephonyEnable API. |
Assembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SipTelephonyEnable() |
Visual Basic (Declaration) |
---|
Public Function SipTelephonyEnable As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
Visual C++ |
---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SipTelephonyEnable() |
J# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SipTelephonyEnable() |
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 Value | Description |
---|---|
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) |
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.