SetOutgoingLineOnly

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.

TELEPHONY_RETURN_VALUE SetOutgoingLineOnly(

SIPHANDLE hStateMachine,

int PhoneLine,
BOOL EnableState

);

Parameters:

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

PhoneLine

[in] The zero based phone line to configure.

EnableState

[in] 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 TELEPHONY_RETURN_VALUE data type.

Value	Description
SipInvalidHandle	An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.
SipBadPhoneLine	A telephony operation was specified using an invalid phone line. Phone lines are numbered starting from zero.
SipCallFailure	This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.