lineSetAppSpecific function (tapi.h)

Article
02/22/2024

The lineSetAppSpecific function enables an application to set the application-specific field of the specified call's call-information record.

Syntax

LONG lineSetAppSpecific(
  HCALL hCall,
  DWORD dwAppSpecific
);

Parameters

hCall

Handle to the call whose application-specific field needs to be set. The application must be an owner of the call. The call state of hCall can be any state.

dwAppSpecific

New content of the dwAppSpecific member for the call's LINECALLINFO structure. This value is not interpreted by the Telephony API.

Return value

Returns zero if the request succeeds or a negative error number if an error occurs. Possible return values are:

LINEERR_INVALCALLHANDLE, LINEERR_RESOURCEUNAVAIL, LINEERR_NOMEM, LINEERR_UNINITIALIZED, LINEERR_NOTOWNER, LINEERR_OPERATIONUNAVAIL, LINEERR_OPERATIONFAILED.

Remarks

The application-specific field in the LINECALLINFO data structure that exists for each call is not interpreted by the Telephony API or any of its service providers. Its usage is entirely defined by the applications. The field can be read from the LINECALLINFO record returned by lineGetCallInfo. However, lineSetAppSpecific must be used to set the field so that changes become visible to other applications. When this field is changed, all other applications with call handles are sent a LINE_CALLINFO message with an indication that the dwAppSpecific member has changed.

Requirements

Requirement	Value
Target Platform	Windows
Header	tapi.h
Library	Tapi32.lib
DLL	Tapi32.dll