lineGetAppPriority (Compact 2013)

3/26/2014

This function allows an application to determine whether or not it is in the handoff priority list for a particular media mode or Assisted Telephony request mode and, if so, its position in the priority list.

Syntax

LONG WINAPI lineGetAppPriority(
  LPCWSTR lpszAppFilename,
  DWORD dwMediaMode,
  LPLINEEXTENSIONID lpExtensionID,
  DWORD dwRequestMode,
  LPVARSTRING lpExtensionName,
  LPDWORD lpdwPriority 
);

Parameters

• lpszAppFilename
  Pointer to a string containing the application executable module file name (without directory information). In API version 2.0 or later, the parameter can be in long file name format, of which the 8.3 file name format is a proper subset. Long file names, unlike 8.3 file names, are case preserving. Neither file name format is case sensitive. See File Name Conventions. In API versions earlier than 2.0, the parameter must specify a file name in the 8.3 format; long file names cannot be used.

• dwMediaMode
  Media mode for which the priority information is to be obtained. The value can be one of the LINEMEDIAMODE constants; only a single bit can be on. The value zero should be used if checking application priority for Assisted Telephony requests.

• lpExtensionID
  Pointer to structure of type LINEEXTENSIONID. This parameter is ignored.

• dwRequestMode
  If the dwMediaMode parameter is zero, this parameter specifies the Assisted Telephony request mode for which priority is to be checked. It must be either LINEREQUESTMODE_MAKECALL or LINEREQUESTMODE_MEDIACALL. This parameter is ignored if dwMediaMode is non-zero.

• lpExtensionName
  This parameter is ignored.

• lpdwPriority
  Pointer to a DWORD-size memory location into which TAPI writes the priority of the application for the specified media or request mode. The value zero is returned if the application is not in the stored priority list and does not currently have any line device open with ownership requested of the specified media mode or having registered for the specified request mode.

  In API versions earlier than 2.0, the value -1 (0xFFFFFFFF) is returned if the application has the line open for the specified media mode or has registered for the specified requests, but the application is not in the stored priority list (that is, it is in the temporary priority list only). In API version 2.0 or later, the value zero is returned to indicate this condition.

  Otherwise, the value indicates the application's position in the list (with 1 being highest priority, and increasing values indicating decreasing priority).

Return Value

Returns zero if the request succeeds or a negative error number if an error occurs. The following table shows the return values for this function.

Remarks

If LINEERR_INVALMEDIAMODE is returned, the value specified in dwMediaMode is not zero, not a valid extended media mode, and not one of the LINEMEDIAMODE constants, or more than one bit is on in the parameter value.

Although this is a new function that older applications would not be expected to call, for backward compatibility they should not be prevented from doing so; the function works the same way for all applications.

Requirements

See Also

Reference

TAPI Line Device Functions
VARSTRING