lineGetIconW 関数 (tapi.h)

lineGetIcon 関数を使用すると、アプリケーションは、ユーザーに表示するサービス ラインデバイス固有の (またはプロバイダー固有の) アイコンを取得できます。

構文

LONG lineGetIconW(
  DWORD   dwDeviceID,
  LPCWSTR lpszDeviceClass,
  LPHICON lphIcon
);

パラメーター

dwDeviceID

アイコンが要求された回線デバイスの識別子。

lpszDeviceClass

デバイス クラス名を識別する -terminated 文字列null へのポインター。 このデバイス クラスを使用すると、アプリケーションは、そのデバイス クラスに適用できる特定のサブアイコンを選択できます。 このパラメーターは省略可能であり、NULL または空 残すことができます。この場合、指定されたメディア ストリーム デバイスではなく、ライン デバイスに関連付けられている最上位レベルのアイコンが選択されます。

lphIcon

アイコンへのハンドルが返されるメモリ位置へのポインター。

戻り値

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

LINEERR_BADDEVICEID、LINEERR_OPERATIONFAILED、LINEERR_INVALPOINTER、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALDEVICECLASS、LINEERR_UNINITIALIZED、LINEERR_NOMEM、LINEERR_NODEVICE。

備考

lineGetIcon 関数により、プロバイダーは指定された行に関連付けられているアイコン リソース (LoadIconから取得) にハンドル (lphIcon) を返します。 アイコン ハンドルは、プロバイダーに関連付けられているリソース用です。 アプリケーションは、プロバイダーのアンロード後にアイコンを参照する場合は、CopyIcon を使用する必要があります。これは、アプリケーションが行を開いている限り発生する可能性は低くなります。

lpszDeviceClass パラメーターを使用すると、プロバイダーは呼び出し元によって参照されるサービスの種類に基づいて異なるアイコンを返すことができます。 許可される文字列は、lineGetIDの場合と同じです。 たとえば、行が Comm API をサポートしている場合、lpszDeviceClass として "COMM" 渡すと、プロバイダーはサービス プロバイダーの Comm デバイス関数に特に関連するアイコンを返します。 パラメーター "tapi/line"、""、または NULL を使用して、ライン サービスのアイコンを要求できます。

2.0 より前のバージョンの API を使用しているアプリケーションの場合、プロバイダーがアイコンを返さない場合 (指定されたデバイス クラスが無効であるか、プロバイダーがアイコンをサポートしていないかにかかわらず)、TAPI は汎用テレフォニー回線デバイス アイコンに置き換えます。 API バージョン 2.0 以降を使用するアプリケーションでは、lpszDeviceClass パラメーターが "tapi/line"、""、または NULLの場合にのみ、TAPI によって既定の行アイコンが置き換えられます。 その他のデバイス クラスの場合、指定されたデバイス クラスが有効でない場合、またはプロバイダーがクラスのアイコンをサポートしていない場合、lineGetIcon はLINEERR_INVALDEVICECLASSを返します。

手記

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

必要条件

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

関連項目

基本的なテレフォニー サービス リファレンス

TAPI 2.2 リファレンスの概要

lineGetID を する