lineGetAppPriority

The lineGetAppPriority 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.

LONG lineGetAppPriority(

LPCSTR lpszAppFilename,
DWORD dwMediaMode,
LPLINEEXTENSIONID const lpExtensionID,
DWORD dwRequestMode,
LPVARSTRING lpExtensionName,
LPDWORD lpdwPriority
);

Parameters
lpszAppFilename

A pointer to a string containing the application executable module filename (without directory information). In API versions 0x00020000 and greater, the parameter can be in either long or 8.3 filename format. In API versions less than 0x00020000, the parameter must specify a filename in the 8.3 format; long filenames cannot be used.

dwMediaMode

The media mode for which the priority information is to be obtained. The value may be one of the LINEMEDIAMODE_ constants; only a single bit may be on. The value 0 should be used if checking application priority for Assisted Telephony requests.

lpExtensionID

A pointer to structure of type LINEEXTENSIONID. This parameter is ignored.

dwRequestMode

If the dwMediaMode parameter is 0, 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

A pointer to a DWORD-size memory location into which TAPI will write the priority of the application for the specified media or request mode. The value 0 will be 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 less than 0x00020000, 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 versions 0x00020000 and greater, the value 0 is returned to indicate this condition.

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

Return Values
Returns zero if the request is successful or a negative error number if an error has occurred. Possible return values are:

LINEERR_INIFILECORRUPT, LINEERR_INVALREQUESTMODE, LINEERR_INVALAPPNAME, LINEERR_NOMEM, LINEERR_INVALMEDIAMODE, LINEERR_OPERATIONFAILED, LINEERR_INVALPOINTER, LINEERR_STRUCTURETOOSMALL.

Remarks
If LINEERR_INVALMEDIAMODE is returned, the value specified in dwMediaMode is not 0, not a valid extended media mode, and not a LINEMEDIAMODE_ constant, or more than one bit is on in the parameter value.

Also, long filenames are now permitted for lpszAppFilename; 8.3 names are acceptable, but no longer required.

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