TSPI_lineGetIcon関数 (tspi.h)

  • [アーティクル]

TSPI_lineGetIcon関数は、ユーザーに表示するサービスラインデバイス固有のアイコンを取得します。

構文

LONG TSPIAPI TSPI_lineGetIcon(
  DWORD   dwDeviceID,
  LPCWSTR lpszDeviceClass,
  LPHICON lphIcon
);

パラメーター

dwDeviceID

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

lpszDeviceClass

デバイス クラス名を識別する null で終わる Unicode 文字列へのポインター。 このデバイス クラスを使用すると、呼び出し元はそのデバイス クラスに固有のアイコンを選択できます。 このパラメーターは省略可能であり、 NULL のままにすることができます。この場合、指定されたメディア ストリーム デバイスではなく、回線デバイスに関連付けられている最上位レベルのアイコンが選択されます。

許可される文字列は、 TSPI_lineGetIDの場合と同じです。 たとえば、行が Comm API をサポートしている場合、comm/datamodem を lpszDeviceClass として渡すと、プロバイダーはサービス プロバイダーの Comm デバイス機能に関連するアイコンを返します。

lphIcon

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

戻り値

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

LINEERR_INVALDEVICECLASS、LINEERR_OPERATIONFAILED、LINEERR_NOMEM、LINEERR_RESOURCEUNAVAIL、LINEERR_OPERATIONUNAVAIL。

解説

プロバイダーは、(lphIcon が指す DWORD 内の) ハンドルをアイコン リソース (から取得) に返す必要があります。
LoadIcon 関数) を指定した行に関連付けます。

プロバイダーは、多くのアイコン (lpszDeviceClass や行番号で選択)、1 つのアイコン (lpszDeviceClass が選択されている場合に関係なく、すべてのTSPI_lineGetIcon要求に対して返される製造元など) をサポートするか、アイコンを使用しないかを選択できます。その場合、lphIcon が指す DWORD は NULL に設定されます。 TAPI はプロバイダーから返されたハンドルを調べ、プロバイダーが NULL を返す場合、TAPI は汎用テレフォニー アイコン (汎用の "行" アイコン) に置き換えます。

要件

   
対象プラットフォーム Windows
ヘッダー tspi.h

関連項目

TSPI_lineConfigDialog

TSPI_lineGetID