Win32 API 日本語リファレンス
ホーム › Devices.Fax › IFaxDeviceProvider

IFaxDeviceProvider

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID290eac63-83ec-449c-8417-f148df8c682a継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IFaxDeviceProvider インターフェイスは、FAX クライアント アプリケーションが FAX サービスに登録されている FAX サービス プロバイダー (FSP) の情報を取得するために使用する構成オブジェクトを定義します。

解説(Remarks)

IFaxDeviceProvider の既定の実装は、FaxDeviceProvider オブジェクトとして提供されます。

メソッド 12

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_FriendlyName(LPWSTR* pbstrFriendlyName)

IFaxDeviceProvider::get_FriendlyName プロパティは、FAX サービス プロバイダー (FSP) のわかりやすい名前を格納する null 終端文字列です。この文字列はユーザーへの表示に適しています。

pbstrFriendlyNameLPWSTR*outデバイスプロバイダの表示用フレンドリ名を受け取るBSTRポインタ。
vtbl 8 HRESULT get_ImageName(LPWSTR* pbstrImageName)

IFaxDeviceProvider::get_ImageName プロパティは、FAX サービス プロバイダー (FSP) の実行可能イメージ名 (DLL のパスとファイル名) を格納する null 終端文字列です。

pbstrImageNameLPWSTR*outプロバイダDLLの実行イメージ(ファイル)名を受け取るBSTRポインタ。
vtbl 9 HRESULT get_UniqueName(LPWSTR* pbstrUniqueName)

IFaxDeviceProvider::get_UniqueName プロパティは、FAX サービス プロバイダー (FSP) を識別する一意の名前を格納する null 終端文字列です。

pbstrUniqueNameLPWSTR*outプロバイダを一意に識別する内部名を受け取るBSTRポインタ。
vtbl 10 HRESULT get_TapiProviderName(LPWSTR* pbstrTapiProviderName)

IFaxDeviceProvider::get_TapiProviderName プロパティは、FAX サービス プロバイダー (FSP) の FAX デバイスに関連付けられているテレフォニー サービス プロバイダー (TSP) の名前を格納する null 終端文字列です。

pbstrTapiProviderNameLPWSTR*out関連付けられたTAPIサービスプロバイダ名を受け取るBSTRポインタ。
vtbl 11 HRESULT get_MajorVersion(INT* plMajorVersion)

IFaxDeviceProvider::get_MajorVersion プロパティは、FAX サービス プロバイダー (FSP) DLL のバージョン番号のメジャー部分を指定する値です。

plMajorVersionINT*outプロバイダのメジャーバージョン番号を受け取るINTポインタ。

解説(Remarks)

バージョン番号の標準的な形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

vtbl 12 HRESULT get_MinorVersion(INT* plMinorVersion)

IFaxDeviceProvider::get_MinorVersion プロパティは、FAX サービス プロバイダー (FSP) DLL のバージョン番号のマイナー部分を指定する値です。

plMinorVersionINT*outプロバイダのマイナーバージョン番号を受け取るINTポインタ。

解説(Remarks)

バージョン番号の標準的な形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

vtbl 13 HRESULT get_MajorBuild(INT* plMajorBuild)

IFaxDeviceProvider::get_MajorBuild プロパティは、FAX サービス プロバイダー (FSP) DLL のビルド番号のメジャー部分を指定する値です。

plMajorBuildINT*outプロバイダのメジャービルド番号を受け取るINTポインタ。

解説(Remarks)

ビルド番号の標準的な形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

vtbl 14 HRESULT get_MinorBuild(INT* plMinorBuild)

IFaxDeviceProvider::get_MinorBuild プロパティは、FAX サービス プロバイダー (FSP) DLL のビルド番号のマイナー部分を指定する値です。

plMinorBuildINT*outプロバイダのマイナービルド番号を受け取るINTポインタ。

解説(Remarks)

ビルド番号の標準的な形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

vtbl 15 HRESULT get_Debug(VARIANT_BOOL* pbDebug)

IFaxDeviceProvider::get_Debug プロパティは、FAX サービス プロバイダー (FSP) DLL がデバッグ環境で作成されたかどうかを示すブール値です。

pbDebugVARIANT_BOOL*outプロバイダがデバッグビルドかを受け取るVARIANT_BOOLポインタ。VARIANT_TRUEでデバッグ版。

解説(Remarks)

このプロパティが TRUE の場合、FSP DLL はデバッグ環境で作成されています。このプロパティが FALSE の場合、DLL はデバッグ環境では作成されていません。

vtbl 16 HRESULT get_Status(FAX_PROVIDER_STATUS_ENUM* pStatus)

IFaxDeviceProvider::get_Status プロパティは、FAX サービス プロバイダー (FSP) が正常に読み込まれ、初期化されたかどうかを示す数値です。

pStatusFAX_PROVIDER_STATUS_ENUM*outプロバイダの状態を表すFAX_PROVIDER_STATUS_ENUM値を受け取るポインタ。読込成功/失敗等を示す。

解説(Remarks)

FSP の読み込みに失敗した場合、このプロパティは失敗の理由を示し、IFaxDeviceProvider::get_InitErrorCode に最後のエラー コード値が保持されます。詳細については、FAX_PROVIDER_STATUS_ENUM を参照してください。

vtbl 17 HRESULT get_InitErrorCode(INT* plInitErrorCode)

IFaxDeviceProvider::get_InitErrorCode プロパティは、FAX サービスが FSP DLL を読み込んで初期化している間に FAX サービス プロバイダー (FSP) が返した最後のエラー コードを指定する値です。

plInitErrorCodeINT*outプロバイダ初期化時のエラーコード(Win32/HRESULT)を受け取るINTポインタ。0で成功。
vtbl 18 HRESULT get_DeviceIds(VARIANT* pvDeviceIds)

IFaxDeviceProvider::get_DeviceIds プロパティは、long 型のバリアント セーフ配列 (VT_I4 | VT_ARRAY) を返します。配列内の各 long 値はデバイス ID です。

pvDeviceIdsVARIANT*outこのプロバイダが管理するデバイスIDの配列をSAFEARRAY等で格納したVARIANTを受け取るポインタ。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数: 
#define global IID_IFaxDeviceProvider "{290EAC63-83EC-449C-8417-F148DF8C682A}"
#usecom global IFaxDeviceProvider IID_IFaxDeviceProvider "{}"
#comfunc global IFaxDeviceProvider_get_FriendlyName      7 var
#comfunc global IFaxDeviceProvider_get_ImageName         8 var
#comfunc global IFaxDeviceProvider_get_UniqueName        9 var
#comfunc global IFaxDeviceProvider_get_TapiProviderName  10 var
#comfunc global IFaxDeviceProvider_get_MajorVersion      11 var
#comfunc global IFaxDeviceProvider_get_MinorVersion      12 var
#comfunc global IFaxDeviceProvider_get_MajorBuild        13 var
#comfunc global IFaxDeviceProvider_get_MinorBuild        14 var
#comfunc global IFaxDeviceProvider_get_Debug             15 var
#comfunc global IFaxDeviceProvider_get_Status            16 var
#comfunc global IFaxDeviceProvider_get_InitErrorCode     17 var
#comfunc global IFaxDeviceProvider_get_DeviceIds         18 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。