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

IFaxReceiptOptions

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

公式ドキュメント

IFaxReceiptOptions インターフェイスは、FAX クライアント アプリケーションが FAX 送信の配信レシートを FAX サービスが送信する際に使用するレシート構成を設定および取得するために用いる FaxReceiptOptions 構成オブジェクトを定義します。

解説(Remarks)

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

メソッド 18

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

vtbl 7 HRESULT get_AuthenticationType(FAX_SMTP_AUTHENTICATION_TYPE_ENUM* pType)

IFaxReceiptOptions::get_AuthenticationType プロパティは、FAX サービスが Simple Mail Transport Protocol (SMTP) サーバーに接続する際に使用する認証の種類を指定します。(Get)

pTypeFAX_SMTP_AUTHENTICATION_TYPE_ENUM*outSMTP認証方式を表すFAX_SMTP_AUTHENTICATION_TYPE_ENUMを受け取る出力先。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 8 HRESULT put_AuthenticationType(FAX_SMTP_AUTHENTICATION_TYPE_ENUM Type)

IFaxReceiptOptions::get_AuthenticationType プロパティは、FAX サービスが Simple Mail Transport Protocol (SMTP) サーバーに接続する際に使用する認証の種類を指定します。(Put)

TypeFAX_SMTP_AUTHENTICATION_TYPE_ENUMin設定するSMTP認証方式FAX_SMTP_AUTHENTICATION_TYPE_ENUM値。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 9 HRESULT get_SMTPServer(LPWSTR* pbstrSMTPServer)

IFaxReceiptOptions::get_SMTPServer プロパティは、Simple Mail Transport Protocol (SMTP) サーバーの名前を格納する null 終端文字列です。(Get)

pbstrSMTPServerLPWSTR*out送達確認に使うSMTPサーバー名を受け取るBSTR出力先。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 10 HRESULT put_SMTPServer(LPWSTR bstrSMTPServer)

IFaxReceiptOptions::get_SMTPServer プロパティは、Simple Mail Transport Protocol (SMTP) サーバーの名前を格納する null 終端文字列です。(Put)

bstrSMTPServerLPWSTRin設定するSMTPサーバー名。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 11 HRESULT get_SMTPPort(INT* plSMTPPort)

IFaxReceiptOptions::get_SMTPPort プロパティは、Simple Mail Transport Protocol (SMTP) のポート番号を指定する値です。(Get)

plSMTPPortINT*outSMTPサーバーのポート番号を受け取る出力先。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 12 HRESULT put_SMTPPort(INT lSMTPPort)

IFaxReceiptOptions::get_SMTPPort プロパティは、Simple Mail Transport Protocol (SMTP) のポート番号を指定する値です。(Put)

lSMTPPortINTin設定するSMTPポート番号(通常25)。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 13 HRESULT get_SMTPSender(LPWSTR* pbstrSMTPSender)

IFaxReceiptOptions::get_SMTPSender プロパティは、メール メッセージ レシートの送信者の Simple Mail Transport Protocol (SMTP) 電子メール アドレスを格納する null 終端文字列です。(Get)

pbstrSMTPSenderLPWSTR*out送達確認メールの差出人アドレスを受け取るBSTR出力先。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 14 HRESULT put_SMTPSender(LPWSTR bstrSMTPSender)

IFaxReceiptOptions::get_SMTPSender プロパティは、メール メッセージ レシートの送信者の Simple Mail Transport Protocol (SMTP) 電子メール アドレスを格納する null 終端文字列です。(Put)

bstrSMTPSenderLPWSTRin設定する差出人メールアドレス。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 15 HRESULT get_SMTPUser(LPWSTR* pbstrSMTPUser)

IFaxReceiptOptions::get_SMTPUser プロパティは、認証付き接続で使用する Simple Mail Transport Protocol (SMTP) のユーザー名を格納する null 終端文字列です。(Get)

pbstrSMTPUserLPWSTR*outSMTP認証用ユーザー名を受け取るBSTR出力先。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 16 HRESULT put_SMTPUser(LPWSTR bstrSMTPUser)

IFaxReceiptOptions::get_SMTPUser プロパティは、認証付き接続で使用する Simple Mail Transport Protocol (SMTP) のユーザー名を格納する null 終端文字列です。(Put)

bstrSMTPUserLPWSTRin設定するSMTP認証用ユーザー名。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 17 HRESULT get_AllowedReceipts(FAX_RECEIPT_TYPE_ENUM* pAllowedReceipts)

IFaxReceiptOptions::get_AllowedReceipts プロパティは、許可される配信レシートの種類を指定する値です。(Get)

pAllowedReceiptsFAX_RECEIPT_TYPE_ENUM*out許可される送達確認種別FAX_RECEIPT_TYPE_ENUMを受け取る出力先。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 18 HRESULT put_AllowedReceipts(FAX_RECEIPT_TYPE_ENUM AllowedReceipts)

IFaxReceiptOptions::get_AllowedReceipts プロパティは、許可される配信レシートの種類を指定する値です。(Put)

AllowedReceiptsFAX_RECEIPT_TYPE_ENUMin設定する許可送達確認種別FAX_RECEIPT_TYPE_ENUM値。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 19 HRESULT get_SMTPPassword(LPWSTR* pbstrSMTPPassword)

IFaxReceiptOptions::get_SMTPPassword プロパティは、認証付き接続で使用する Simple Mail Transport Protocol (SMTP) のパスワードを格納する null 終端文字列です。(Get)

pbstrSMTPPasswordLPWSTR*outSMTP認証用パスワードを受け取るBSTR出力先。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 20 HRESULT put_SMTPPassword(LPWSTR bstrSMTPPassword)

IFaxReceiptOptions::get_SMTPPassword プロパティは、認証付き接続で使用する Simple Mail Transport Protocol (SMTP) のパスワードを格納する null 終端文字列です。(Put)

bstrSMTPPasswordLPWSTRin設定するSMTP認証用パスワード。

解説(Remarks)

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 21 HRESULT Refresh()

IFaxReceiptOptions::Refresh メソッドは、FAX サーバーから FaxReceiptOptions オブジェクトの情報を最新の状態に更新します。IFaxReceiptOptions::Refresh メソッドを呼び出すと、最後に IFaxReceiptOptions::Save メソッドを呼び出した後に行われた構成の変更はすべて失われます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 22 HRESULT Save()

IFaxReceiptOptions::Save メソッドは、FaxReceiptOptions オブジェクトのデータを保存します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

このメソッドは、レシートの種類が frtMAIL に設定されている場合、または IFaxReceiptOptions::get_UseForInboundRouting が TRUE に設定されている場合、Windows XP ではサポートされません。これらの場合、このメソッドはエラー FAX_E_NOT_SUPPORTED_ON_THIS_SKU を返します。

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG および farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 23 HRESULT get_UseForInboundRouting(VARIANT_BOOL* pbUseForInboundRouting)

IFaxReceiptOptions::get_UseForInboundRouting プロパティは、受信 FAX を電子メール アドレスへルーティングできるようにする Microsoft ルーティング拡張機能に対して FaxReceiptOptions の設定を使用するかどうかを設定または取得します。(Get)

pbUseForInboundRoutingVARIANT_BOOL*out受信ルーティングにSMTP設定を使うかをVARIANT_BOOLで受け取る出力先。

解説(Remarks)

設定が使用されない場合 (プロパティが FALSE に設定されている場合)、Microsoft ルーティング拡張機能は無効になり、ユーザーは電子メール アドレスで FAX を受信できません。設定が使用される場合 (プロパティが TRUE に設定されている場合)、Microsoft ルーティング拡張機能は有効になり、ユーザーは電子メール アドレスで FAX を受信できます。

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 24 HRESULT put_UseForInboundRouting(VARIANT_BOOL bUseForInboundRouting)

IFaxReceiptOptions::get_UseForInboundRouting プロパティは、受信 FAX を電子メール アドレスへルーティングできるようにする Microsoft ルーティング拡張機能に対して FaxReceiptOptions の設定を使用するかどうかを設定または取得します。(Put)

bUseForInboundRoutingVARIANT_BOOLin受信ルーティングにSMTP設定を使うか否かのVARIANT_BOOL値。

解説(Remarks)

設定が使用されない場合 (プロパティが FALSE に設定されている場合)、Microsoft ルーティング拡張機能は無効になり、ユーザーは電子メール アドレスで FAX を受信できません。設定が使用される場合 (プロパティが TRUE に設定されている場合)、Microsoft ルーティング拡張機能は有効になり、ユーザーは電子メール アドレスで FAX を受信できます。

このプロパティを読み取りまたは書き込みするには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxReceiptOptions "{378EFAEB-5FCB-4AFB-B2EE-E16E80614487}"
#usecom global IFaxReceiptOptions IID_IFaxReceiptOptions "{}"
#comfunc global IFaxReceiptOptions_get_AuthenticationType    7 var
#comfunc global IFaxReceiptOptions_put_AuthenticationType    8 int
#comfunc global IFaxReceiptOptions_get_SMTPServer            9 var
#comfunc global IFaxReceiptOptions_put_SMTPServer            10 wstr
#comfunc global IFaxReceiptOptions_get_SMTPPort              11 var
#comfunc global IFaxReceiptOptions_put_SMTPPort              12 int
#comfunc global IFaxReceiptOptions_get_SMTPSender            13 var
#comfunc global IFaxReceiptOptions_put_SMTPSender            14 wstr
#comfunc global IFaxReceiptOptions_get_SMTPUser              15 var
#comfunc global IFaxReceiptOptions_put_SMTPUser              16 wstr
#comfunc global IFaxReceiptOptions_get_AllowedReceipts       17 var
#comfunc global IFaxReceiptOptions_put_AllowedReceipts       18 int
#comfunc global IFaxReceiptOptions_get_SMTPPassword          19 var
#comfunc global IFaxReceiptOptions_put_SMTPPassword          20 wstr
#comfunc global IFaxReceiptOptions_Refresh                   21
#comfunc global IFaxReceiptOptions_Save                      22
#comfunc global IFaxReceiptOptions_get_UseForInboundRouting  23 var
#comfunc global IFaxReceiptOptions_put_UseForInboundRouting  24 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。