lineGetIcon 関数 (tapi.h)

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

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

構文

LONG lineGetIcon(
  DWORD   dwDeviceID,
  LPCSTR  lpszDeviceClass,
  LPHICON lphIcon
);

パラメーター

dwDeviceID

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

lpszDeviceClass

デバイスクラス名を識別する 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を返します。