The SetOutgoingLineOnly function allows you to specify that a specific phone line be reserved for
out-bound calling only. If a phone line is configured for "out going calls only", the media engine
will never attempt to assign an incoming phone call to the line. Useful for multi-line VOIP Media
Engines. Most often used to simplify internal application call manipulation logic.
Namespace:
LanScapeAssembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetOutgoingLineOnly( int PhoneLine, bool EnableState ) |
Visual Basic (Declaration) |
---|
Public Function SetOutgoingLineOnly ( _ PhoneLine As Integer, _ EnableState As Boolean _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
Visual C++ |
---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetOutgoingLineOnly( int PhoneLine, bool EnableState ) |
J# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetOutgoingLineOnly( int PhoneLine, boolean EnableState ) |
Parameters
- PhoneLine
- Type: System..::.Int32
The zero based phone line to configure.
- EnableState
- Type: System..::.Boolean
The "line out only" enable state. If specified as non zero, the phone line will be placed into "output only" mode. To return a phone line to normal operation, specify a value of zero (FALSE) for this parameter.
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) |
SipBadPhoneLine |
Application software called a telephony API procedure and specified an invalid phone line. Phone lines are numbered starting from zero. This error is most commonly returned when attempting to access phone lines in excess of the max number of lines supported by the telephony engine.
(API return value) |
Remarks
None.