By: Yaron Goali (WISERBIT DOT COM) for Microncode.com

User Control: cTapi

Properties

LineIndex [Let] - Public


Description: Set the line index

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	LineIndex	Long

LineIndex [Get] - Public (Return Datatype: Long)


Description: Get the line index
No Parameters

PhoneIndex [Let] - Public


Description: Set the phone index

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	PhoneIndex	Long

PhoneIndex [Get] - Public (Return Datatype: Long)


Description: Get the phone index
No Parameters

Functions

CloseOpenedHandle - Public (Return Datatype: Boolean)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lHandle	Long

DeInit - Public (Return Datatype: Long)


Description: DeInit the control, must be call before closing the program.
Return: 0 if success, otherwise a number describe the error.
No Parameters

GetCityCode - Public (Return Datatype: String)


Description: Get the local city code
Return: String with the city code
No Parameters

GetCountryCode - Public (Return Datatype: String)


Description: Get the local country code
Return: String with the country code
No Parameters

GetTapiStrError - Public (Return Datatype: String)


Description: Get description about the error number by the ErrorNumber
Return: a string describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	ErrorNumber	Long

Init - Public (Return Datatype: Long)


Description: Init the control, must be call before using any functionality of the control.
Return: 0 if success, otherwise a number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	sKey	String

IsLineOpen - Public (Return Datatype: Boolean)


Description: Check if the line is open.
Return: True if open, false if close.
No Parameters

IsPhoneOpen - Public (Return Datatype: Boolean)


Description: Check if the phone device is open.
Return: True if open, false if close.
No Parameters

LineAnswer - Public (Return Datatype: Long)


Description: Answer to an incoming call
Return: Zero if success, or an error number describe the error
No Parameters

LineCallBack - Friend (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	dwDevice	Long
	ByVal	dwMessage	Long
	ByVal	dwParam1	Long
	ByVal	dwParam2	Long
	ByVal	dwParam3	Long

LineClose - Public (Return Datatype: Long)


Description: Close the line
Return: Zero if success, or an error number describe the error
No Parameters

LineConfigDialog - Public (Return Datatype: Long)


Description: The lineConfigDialog function causes the provider of the specified line device to display a dialog box (attached to hwndOwner of the application) to allow the user to configure parameters related to the line device.
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	LineIndex	Long

LineDrop - Public (Return Datatype: Long)


The lineDrop function drops or disconnects the specified call.
Return: Zero if success, or an error number describe the error
No Parameters

LineGenerateDigits - Public (Return Datatype: Long)


Description: Generate digits to a call
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Digits	String

LineGetDevDetails - Public (Return Datatype: Long)


Description: Get general information about the device to the DeviceType type
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
		DeviceType	LineDevCap

LineGetDevDetailsProps - Public (Return Datatype: Long)


Description: Get general information about the device capibility by pointers.
Return: Boolean value.

Optional	ByVal/ByRef	Variable	Datatype
		DeviceName	String
		MaxRate	Long
		Voice	Boolean
		MonitorDigits	Boolean
		GenerateDigits	Boolean

LineGetDevDetailsTypes - Public (Return Datatype: Long)


Description: Get general information about the device capibility by pointers.
Return: Boolean value.

Optional	ByVal/ByRef	Variable	Datatype
		MediaUnknown	Boolean
		MediaInteractivevoice	Boolean
		MediaAutomatedvoice	Boolean
		MediaDatamodem	Boolean
		MediaG3fax	Boolean
		TapiCapability	Boolean

lineGetID - Public (Return Datatype: Long)


Description: Returns a device identifier for the specified device. This function can be use to record (LineIn) or to play (LineOut) an audio from or to the line with WAV Player Recorder ActiveX.
Return: Number describe the device, or a negative number describe the error.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lDeviceClass	DEVICECLASS

lineGetIDX - Public (Return Datatype: Long)


Description: C++/VC6 interface. Returns a device identifier for the specified device. This function can be use to record (LineIn) or to play (LineOut) an audio from or to the line with WAV Player Recorder ActiveX.
Return: Number describe the device, or a negative number describe the error.
WAVEIN = &H1&
WAVEOUT = &H2&
WAVEINOUT = &H4&
COMMDATA = &H16&

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lDeviceClass	Long

LineHandoff - Public (Return Datatype: Long)


Description: The lineHandoff function gives ownership of the specified call to another application. The application can be either specified directly by its file name or indirectly as the highest priority application that handles calls of the specified media mode.
Return: zero if the request succeeds or a negative error number if an error occurs.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lpszFileName	String
	ByVal	dwMediaMode	LINEMEDIAMODE

LineHandoffX - Public (Return Datatype: Long)


Description: C++/VC6 interface. The lineHandoff function gives ownership of the specified call to another application. The application can be either specified directly by its file name or indirectly as the highest priority application that handles calls of the specified media mode.
Return: zero if the request succeeds or a negative error number if an error occurs.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lpszFileName	String
	ByVal	dwMediaMode	Long

lineHold - Public (Return Datatype: Long)


Description: The lineHandoff function gives ownership of the specified call to another application. The application can be either specified directly by its file name or indirectly as the highest priority application that handles calls of the specified media mode.
Return: zero if the request succeeds or a negative error number if an error occurs.
No Parameters

LineInitialize - Public (Return Datatype: Long)


Initialize the control, this function must
be call before using any line functionailty of
the control.
No Parameters

LineIsConnected - Public (Return Datatype: Boolean)


Description: Check if the line is connected.
Return: True if connected, false if not connected.
No Parameters

LineMakeCall - Public (Return Datatype: Long)


Description: Asynchronous function to dial a call
Return: The number of the asynchronous process or 0 if an error appears.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Number	String

LineMonitorDigits - Public (Return Datatype: Long)


Description: This function enables and disables the unbuffered detection of digits received on the call. Each time a digit of the specified digit mode is detected, a message is sent to the application by the MonitorDigit event indicating which digit has been detected.
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	Status	Boolean

LineOpen - Public (Return Datatype: Long)


Description: Open the line to receive new calls.
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	CallPrivilege	LINECALLPRIVILEGE
	ByVal	MediaMode	LINEMEDIAMODE

LineOpenX - Public (Return Datatype: Long)


Description: C++/VC6 interface. Open the line to receive new calls. Good for VC6.
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	CallPrivilege	Long
	ByVal	MediaMode	Long

LineSetCallPrivilege - Public (Return Datatype: Long)


Description: The lineSetCallPrivilege function sets the application's privilege to the specified privilege.
Return: zero if the request succeeds or a negative error number if an error occurs.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	CallPrivilege	LINECALLPRIVILEGE

LineSetCallPrivilegeX - Public (Return Datatype: Long)


Description: C++/VC6 interface. The lineSetCallPrivilege function sets the application's privilege to the specified privilege.
Return: zero if the request succeeds or a negative error number if an error occurs.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	CallPrivilege	Long

LineSetTerminal - Public (Return Datatype: Long)


Description: The lineSetTerminal function enables an application to specify which terminal information related to the specified line, address, or call is to be routed. The lineSetTerminal function can be used while calls are in progress on the line to allow an application to route these events to different devices as required.
Return: a positive request identifier if the function is completed asynchronously, or a negative error number if an error occurs.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	dwSelect	LINECALLSELECT
	ByVal	dwTerminalModes	LINETERMMODE

LineSetTerminalX - Public (Return Datatype: Long)


Description: C++/VC6 interface. The lineSetTerminal function enables an application to specify which terminal information related to the specified line, address, or call is to be routed. The lineSetTerminal function can be used while calls are in progress on the line to allow an application to route these events to different devices as required.
Return: a positive request identifier if the function is completed asynchronously, or a negative error number if an error occurs.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	dwSelect	Long
	ByVal	dwTerminalModes	Long

LineShutdown - Public (Return Datatype: Long)


Description: Shutdown the line, call this function after the line has closed.
Return: Zero if success, or an error number describe the error
No Parameters

LineTranslateDialog - Public (Return Datatype: String)


Description: The lineTranslateDialog function displays an application-modal dialog box that allows the user to change the current location of a phone number about to be dialed, adjust location and calling card parameters, and see the effect.
Return: a string with the results
No Parameters

lineUnhold - Public (Return Datatype: Long)


Description: The lineHandoff function gives ownership of the specified call to another application. The application can be either specified directly by its file name or indirectly as the highest priority application that handles calls of the specified media mode.
Return: zero if the request succeeds or a negative error number if an error occurs.
No Parameters

NumOfLines - Public (Return Datatype: Long)


Description: Get the number of lines in the system, use this function after initialize the line
Return: The number of lines in the system
No Parameters

NumOfPhones - Public (Return Datatype: Long)


Description: Get the number of phones in the system, use this function after initialize the phone (PhoneInitialize)
Return: The number of phones in the system
No Parameters

PhoneClose - Public (Return Datatype: Long)


Description: Close the phone
Return: Zero if success, or an error number describe the error
No Parameters

PhoneInitialize - Public (Return Datatype: Long)


Initialize the phone control, this function must
be call before using any phone functionailty of
the control.
No Parameters

PhoneOpen - Public (Return Datatype: Long)


Description: Open the phone to receive new calls.
Return: Zero if success, or an error number describe the error
No Parameters

PhoneSetHookSwitch - Public (Return Datatype: Long)


Description: The phoneSetHookSwitch function sets the hook state of the specified open phone's hookswitch devices to the specified mode. Only the hookswitch state of the hookswitch devices listed is affected.
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	dwHookSwitchDevs	PHONEHOOKSWITCHDEV
	ByVal	dwHookSwitchMode	PHONEHOOKSWITCHMODE

PhoneSetHookSwitchX - Public (Return Datatype: Long)


Description: C++/VC6 interface. The phoneSetHookSwitch function sets the hook state of the specified open phone's hookswitch devices to the specified mode. Only the hookswitch state of the hookswitch devices listed is affected.
Return: Zero if success, or an error number describe the error

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	dwHookSwitchDevs	Long
	ByVal	dwHookSwitchMode	Long

PhoneShutdown - Public (Return Datatype: Long)


Description: Shutdown the phone, call this function after the phone has closed.
Return: Zero if success, or an error number describe the error
No Parameters

ProcNumber - Public


***************************************************************
Events:
***************************************************************

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	ProcNumber	Long
	ByVal	ResultNumber	Long