lineGetAppPriority 関数 (tapi.h)

[アーティクル]
03/02/2024

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

構文

LONG lineGetAppPriority(
  LPCSTR            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

TAPI が指定したメディアまたは要求モードのアプリケーションの優先順位を書き込む DWORD サイズのメモリ位置へのポインター。値 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。