The HoldLine procedure is used to place a phone call on hold. Calling this procedure also notifies the far end of the call with the appropriate hold state. Any number of phone lines that are active can independently be place into or removed from the hold state.

When you place a call on hold, you have the ability to stream audio data to the far end for the duration of the hold operation. For more information regarding streaming audio data to a line that is on hold, see API procedure TransmitOnHoldIvrData(array<Object>[]()[]).

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE HoldLine(
	int PhoneLine,
	bool HoldState
)
Visual Basic (Declaration)
Public Function HoldLine ( _
	PhoneLine As Integer, _
	HoldState As Boolean _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE HoldLine(
	int PhoneLine, 
	bool HoldState
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE HoldLine(
	int PhoneLine,
	boolean HoldState
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to put on hold.
HoldState
Type: System..::.Boolean
Specifies the hold state of the phone line. If TRUE, the phone line is on hold. If FALSE, the phone line characteristics are normal.

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)

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)

SipConferenceActive
Application software attempted to remove a phone call from the hold state using the HoldLine(Int32, Boolean) API procedure when an active conference session was under way. Once a conference session is started, application software should manipulate conference and hold call state using the ConferenceLine(Int32, Boolean) API procedure.

(API return value)

Remarks

None.

See Also