lineGetIcon 函式 (tapi.h)

發行項
03/13/2024

lineGetIcon 函式可讓應用程式擷取服務線路裝置特定 (或提供者特定) 圖示，向用戶顯示。

語法

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

參數

dwDeviceID

要求圖示之線條裝置的標識碼。

lpszDeviceClass

識別裝置類別名稱之 Null 終止字串的指標。此裝置類別可讓應用程式選取適用於該裝置類別的特定子圖示。此參數是選擇性的，而且可以保留 NULL 或空白，在此情況下，會選取與線條裝置相關聯的最高層級圖示，而不是選取指定的媒體數據流裝置。

lphIcon

傳回圖示句柄的記憶體位置指標。

傳回值

如果要求成功或發生錯誤，則傳回零。可能的傳回值為：

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

備註

lineGetIcon 函式會讓提供者將 lphIc) on 中的句柄 (傳回至圖示資源， (從 LoadIcon) 取得，且與指定行相關聯。圖示句柄適用於與提供者相關聯的資源。如果應用程式想要在卸除提供者之後參考圖示，則應用程式必須使用 CopyIcon ，只要應用程式開啟行，就不太可能發生此情況。

lpszDeviceClass 參數可讓提供者根據呼叫端所參考的服務類型傳回不同的圖示。允許的字串與 lineGetID相同。例如，如果行支援 Comm API，將「COMM」當做 lpszDeviceClass 傳遞，會導致提供者傳回與服務提供者的 Comm 裝置功能相關的圖示。參數 “tapi/line”、“” 或 NULL 可用來要求行服務的圖示。

對於使用早於 2.0 的 API 版本的應用程式，如果提供者未傳回圖示， (因為指定的裝置類別無效，或提供者不支援圖示) ，TAPI 會取代一般 Telephony line 裝置圖示。對於使用 API 2.0 版或更新版本的應用程式，TAPI 只有在 lpszDeviceClass 參數是 “tapi/line”、“” 或 NULL 時，才會取代預設行圖示。對於任何其他裝置類別，如果指定的裝置類別無效，或提供者不支援類別的圖示， lineGetIcon 會傳回LINEERR_INVALDEVICECLASS。