PHONEBUTTONINFO 構造体 (tapi.h)

[アーティクル]
08/26/2023

PHONEBUTTONINFO 構造体には、電話デバイス上のボタンに関する情報が含まれています。この構造は、複数の TAPI および TSPI 関数で使用されます。

構文

typedef struct phonebuttoninfo_tag {
  DWORD dwTotalSize;
  DWORD dwNeededSize;
  DWORD dwUsedSize;
  DWORD dwButtonMode;
  DWORD dwButtonFunction;
  DWORD dwButtonTextSize;
  DWORD dwButtonTextOffset;
  DWORD dwDevSpecificSize;
  DWORD dwDevSpecificOffset;
  DWORD dwButtonState;
} PHONEBUTTONINFO, *LPPHONEBUTTONINFO;

メンバー

dwTotalSize

このデータ構造に割り当てられた合計サイズ (バイト単位)。

dwNeededSize

返されるすべての情報をバイト単位で保持するために必要な、このデータ構造のサイズ。

dwUsedSize

有用な情報を含むこのデータ構造の部分のサイズ (バイト単位)。

dwButtonMode

ボタンのモードまたは一般的な使用法クラス。このメンバーは、PHONEBUTTONMODE_定数のいずれかを使用します。

dwButtonFunction

ボタンに割り当てられた関数。このメンバーは、PHONEBUTTONFUNCTION_定数のいずれかを使用します。

dwButtonTextSize

ボタンの説明テキストのサイズ (バイト単位)。

dwButtonTextOffset

この構造体の先頭から、このボタンの説明テキストを含む可変サイズのフィールドへのオフセット。この情報の形式は、電話のデバイス機能の dwStringFormat メンバーで指定されています。フィールドのサイズは dwButtonTextSize によって指定されます。

dwDevSpecificSize

デバイス固有フィールドのサイズ (バイト単位)。デバイス固有のフィールドが文字列へのポインターである場合、サイズには null ターミネータを含める必要があります。

dwDevSpecificOffset

構造体の先頭から可変サイズのデバイス固有フィールドへのオフセット。フィールドのサイズは dwDevSpecificSize によって指定されます。

dwButtonState

phoneGetButtonInfo 関数の場合、このフィールドは、PHONEBUTTONSTATE_定数を使用して、ボタンの現在の状態を示します。このフィールドは、 phoneSetButtonInfo 関数では無視されます。

注釈

デバイス固有の拡張機能では、このデータ構造の DevSpecific (dwDevSpecificSize と dwDevSpecificOffset) の可変サイズ領域を使用する必要があります。

古いアプリケーションは 、このフィールドを PHONEBUTTONINFO 構造体に含めず、新しいサイズより小さい SIZEOF PHONEBUTTONINFO を使用してコンパイルされます。アプリケーションは、phoneOpen 関数を使用して dwAPIVersion パラメーターを渡します。これは、このような状況を処理する TAPI によるガイダンスに使用できます。指定した dwAPIVersion で定義されている構造体の固定部分のサイズより小さい dwTotalSize をアプリケーションが渡すと、PHONEERR_STRUCTURETOOSMALLが返されます。アプリケーションによって十分なメモリが割り当てられている場合、 TSPI_phoneGetButtonInfo 関数を呼び出す前に、TAPI は dwNeededSize メンバーと dwUsedSize メンバーを、指定した API バージョンに存在する構造体の固定サイズに設定します。

新しいサービスプロバイダー (新しい API バージョンをサポート) は、渡された API バージョンを調べる必要があります。 API バージョンがプロバイダーでサポートされている最高バージョンより小さい場合、古い API バージョンではサポートされていないフィールドをサービスプロバイダーが入力しないでください。これは、古い構造の可変部分に含まれるのでです。

新しいアプリケーションは、ネゴシエートされた API バージョンを認識する必要があり、ネゴシエートされた API バージョンの構造体の固定部分の元の末尾を超える固定部分のフィールドの内容を調べないようにする必要があります。