The GoOffHook API procedure is called by application software to accept (answer) an incoming phone call. This procedure can be called any time after the telephony engine event callback sends your application software the SipOkToAnswerCall event.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GoOffHook(
	int PhoneLine
)
Visual Basic (Declaration)
Public Function GoOffHook ( _
	PhoneLine As Integer _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GoOffHook(
	int PhoneLine
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GoOffHook(
	int PhoneLine
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to answer.

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)

SipNotEnabled
Indicates that the telephony engine was not enabled for normal operation. Application software should always execute the SipTelephonyEnable()()() API procedure as the final step during configuration when initializing the telephony engine.

(API return value)

SipAlreadyOffHook
Application software tried to take the phone line off hook when the phone line was already in the off hook state.

(API return value)

SipCallTimeOut

Making an outbound call:

Indicates that a call was initiated using the MakeCall(String, String, UInt32, Int32, Boolean, UInt32) or MakeCallUri(String, Boolean, Int32, Boolean, UInt32) API procedures and call setup did not complete in the time specified. Either the call destination did not respond (is overloaded), the destination of the call is off line, or your host machine could not handle call setup in the time specified. To remove this error, increase the time out value specified to complete the operation.

Terminating a call:

Indicates that a call was terminated using the TerminateCall(Int32, Boolean, UInt32) API procedure and call tear down did not complete in the time specified. Either the call destination did not respond (is overloaded), the destination of the call is off line, or your host machine could not handle call termination in the time specified. To remove this error, increase the time out value specified to complete the operation.

Answering an inbound call:

Indicates that an inbound call was being answered using the GoOffHook(Int32) API procedure and call setup did not complete in the time specified. Either the call destination did not respond (is overloaded), the destination of the call is off line, or your host machine could not answer the call in the time specified. To remove this error, increase the time out value specified to complete the operation.

(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.

See Also