Click or drag to resize
TapiLineDeviceSpecific Method (Object, TapiAddress, TapiCall, Type)
Provides access to device specific functionality.

Namespace: Traysoft.AddTapi
Assembly: Traysoft.AddTapi (in Traysoft.AddTapi.dll) Version: 6.0.0.1110
Syntax
Copy
public Object DeviceSpecific(
	Object inputStruct,
	TapiAddress address,
	TapiCall call,
	Type outputStructType
)

Parameters

inputStruct
Type: SystemObject
A structure that contains input data.
address
Type: Traysoft.AddTapiTapiAddress
An address on the line (if required for the specific function). Set to null reference (Nothing in Visual Basic) if not required.
call
Type: Traysoft.AddTapiTapiCall
A call on the line (if required for the specific function). Set to null reference (Nothing in Visual Basic) if not required.
outputStructType
Type: SystemType
A type of the structure that will contain output data. Set to null reference (Nothing in Visual Basic) if specific function does not return any data.

Return Value

Type: Object
An object of type outputStructType that contains output data or null reference (Nothing in Visual Basic) if there is no output data.
Exceptions
ExceptionCondition
TapiExceptionDeviceSpecific failed because of Telephony API (TAPI) error.
Remarks

Many TSPs provide functionality specific to the telephony system using device specific extensions. Please refer to the TAPI documentation for the telephony hardware to find out about device specific functionality supported by the telephony service provider.

DeviceSpecific method allows the application to access device specific functions implemented by the TSP. Input and output parameters for device specific functions are usualy described as C structures in TAPI documentation for the telephony hardware. You have to define similar structures/classes in your code and use them to pass input and output parameters to DeviceSpecific method. Please see the code snapshot below for more details.

The application has to negotiate a version of the extension supported by the line device using NegotiateDeviceSpecificExtensionVersion(UInt32, UInt32) before opening the line in order to use DeviceSpecific method.

Note Note
This method should be used when device specific function has fixed size structures as input and output data. Use DeviceSpecific(Byte, TapiAddress, TapiCall, Int32) when input or output data have variable length. Please feel free to contact us and we will gladly help with more complex scenarios.
Examples
The following code shows how to use Cisco device specific function that turns on message waiting light.
Copy
// Define a structure that holds parameters for Cisco MsgWaiting function
struct CiscoLineDevSpecificMsgWaiting
{
    public int MsgType;
    public int BlinkRate;
}
...
// Turn on message waiting light on Cisco phone
CiscoLineDevSpecificMsgWaiting msgWaiting;
msgWaiting.MsgType = SLDST_MSG_WAITING;
msgWaiting.BlinkRate = PHONELAMPMODE_STEADY;
line.DeviceSpecific(msgWaiting, null, null, null);
See Also