lineGetAppPriorityW 関数 (tapi.h)

lineGetAppPriority 関数を使用すると、アプリケーションは、特定のメディア モードまたは支援テレフォニー要求モードのハンドオフ優先度リストに含まれているかどうか、および存在する場合は優先度リスト内の位置を判断できます。

構文

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

パラメーター

lpszAppFilename

ディレクトリ データを含まないアプリケーション実行可能モジュール ファイル名を含む文字列へのポインター。 API バージョン 2.0 以降では、パラメーターは長いファイル名形式にすることができます。この形式の 8.3 ファイル名形式は適切なサブセットです。 8.3 ファイル名とは異なり、長いファイル名は大文字と小文字が区別されます。 どちらのファイル名形式でも大文字と小文字は区別されません。 詳細については、「ファイル名規則」を参照してください。 2.0 より前のバージョンの API では、パラメーターは 8.3 形式でファイル名を指定する必要があります。長いファイル名は使用できません。

dwMediaMode

優先順位データを取得するメディア モード。 値は、LINEMEDIAMODE_ 定数のいずれかです。オンにできるのは 1 ビットのみです。 支援されたテレフォニー要求のアプリケーションの優先順位を確認する場合は、値 0 を使用する必要があります。

lpExtensionID

LINEEXTENSIONID型の構造体へのポインター。 このパラメーターは無視されます。

dwRequestMode

このパラメーターの条件は、dwMediaMode パラメーターが 0 の場合、このパラメーターは優先順位をチェックする支援テレフォニー要求モードを指定します。 LINEREQUESTMODE_MAKECALLする必要があります。 dwMediaMode 0 以外の場合、このパラメーターは無視されます。

lpExtensionName

このパラメーターは無視されます。

lpdwPriority

DWORD-size メモリ位置へのポインター。TAPI は、指定されたメディアまたは要求モードのアプリケーションの優先順位を書き込みます。 値 0 は、アプリケーションが格納されている優先順位リストに含まれていないため、現在、指定されたメディア モードで要求された所有権または指定された要求モードに登録されている回線デバイスがない場合に返されます。

2.0 より前のバージョンの API では、指定されたメディア モードの行がアプリケーションで開かれているか、指定された要求に登録されているが、アプリケーションが格納されている優先度リストに含まれていない場合、値 –1 (0xFFFFFFFF) が返されます。つまり、これは一時的な優先順位リストにのみ含まれるということです。 API バージョン 2.0 以降では、この条件を示すために値 0 が返されます。

それ以外の場合、値はリスト内のアプリケーションの位置を示します。1 が最も優先度が高く、優先度が低いことを示す値を増やします。

戻り値

要求が成功した場合は 0 を返し、エラーが発生した場合は負のエラー番号を返します。 可能な戻り値は次のとおりです。

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

備考

LINEERR_INVALMEDIAMODEが返された場合、dwMediaMode で指定された値は 0 ではなく、有効な拡張メディア モードではなく、LINEMEDIAMODE_ 定数の 1 つでも、パラメーター値に複数のビットが入っていません。

手記

tapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして lineGetAppPriority を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件 価値
ターゲット プラットフォーム の ウィンドウズ
ヘッダー tapi.h
ライブラリ Tapi32.lib
DLL Tapi32.dll

関連項目

LINEEXTENSIONID

補助回線サービス関数

TAPI 2.2 リファレンスの概要

VARSTRING を する