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

IFaxOutgoingMessage

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

公式ドキュメント

IFaxOutgoingMessage インターフェイスは、送信済み FAX のアーカイブ内にある FAX メッセージの情報を取得するために FAX クライアント アプリケーションが使用するオブジェクトを表します。

解説(Remarks)

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

メソッド 19

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

vtbl 7 HRESULT get_SubmissionId(LPWSTR* pbstrSubmissionId)

IFaxOutgoingMessage::get_SubmissionId プロパティは、送信処理中に FAX メッセージへ割り当てられた一意の識別子を格納する null 終端文字列です。

pbstrSubmissionIdLPWSTR*out送信要求を一意に識別するサブミッションIDを受け取るBSTRポインタ。
vtbl 8 HRESULT get_Id(LPWSTR* pbstrId)

IFaxOutgoingMessage::get_Id プロパティは、送信 FAX メッセージの一意の識別子を格納する null 終端文字列です。

pbstrIdLPWSTR*outアーカイブ済み送信メッセージを一意に識別するIDを受け取るBSTRポインタ。
vtbl 9 HRESULT get_Subject(LPWSTR* pbstrSubject)

IFaxOutgoingMessage::get_Subject プロパティは、FAX の送付状 (カバー ページ) にある件名フィールドの内容を格納する null 終端文字列です。

pbstrSubjectLPWSTR*out送信メッセージの件名を受け取るBSTR文字列ポインタ。
vtbl 10 HRESULT get_DocumentName(LPWSTR* pbstrDocumentName)

IFaxOutgoingMessage::get_DocumentName プロパティは、FAX メッセージの表示用のわかりやすい名前を格納する null 終端文字列です。

pbstrDocumentNameLPWSTR*out送信メッセージの元ドキュメント名を受け取るBSTR文字列ポインタ。
vtbl 11 HRESULT get_Retries(INT* plRetries)

IFaxOutgoingMessage::get_Retries プロパティは、最初の送信試行が失敗した後に FAX サービスが送信 FAX の送信を試みた回数を示す値です。

plRetriesINT*out送信時に行われた再試行回数を受け取るINTポインタ。
vtbl 12 HRESULT get_Pages(INT* plPages)

IFaxOutgoingMessage::get_Pages プロパティは、送信 FAX メッセージの総ページ数を示す数値です。

plPagesINT*out送信メッセージのページ数を受け取るINTポインタ。
vtbl 13 HRESULT get_Size(INT* plSize)

Size プロパティは、送信 FAX メッセージに関連付けられた Tagged Image File Format Class F (TIFF Class F) ファイルのサイズを示す値です。

plSizeINT*out送信メッセージのサイズ(バイト単位)を受け取るINTポインタ。
vtbl 14 HRESULT get_OriginalScheduledTime(DOUBLE* pdateOriginalScheduledTime)

IFaxOutgoingMessage::get_OriginalScheduledTime プロパティは、FAX メッセージの送信が当初スケジュールされていた時刻を指定します。

pdateOriginalScheduledTimeDOUBLE*out当初予定されていた送信日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 15 HRESULT get_SubmissionTime(DOUBLE* pdateSubmissionTime)

IFaxOutgoingMessage::get_SubmissionTime プロパティは、送信 FAX メッセージが処理のために送信された時刻を示します。

pdateSubmissionTimeDOUBLE*out送信要求が投入された日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 16 HRESULT get_Priority(FAX_PRIORITY_TYPE_ENUM* pPriority)

IFaxOutgoingMessage::get_Priority プロパティは、FAX 送信時に使用される優先度 (標準、低、高など) を指定します。

pPriorityFAX_PRIORITY_TYPE_ENUM*out送信時の優先度を表すFAX_PRIORITY_TYPE_ENUM値を受け取るポインタ。
vtbl 17 HRESULT get_Sender(IFaxSender** ppFaxSender)

IFaxOutgoingMessage::get_Sender プロパティは、FAX メッセージの送信者に関する情報を含むインターフェイスを取得します。

ppFaxSenderIFaxSender**out送信者情報を表すIFaxSenderインターフェイスを受け取るポインタ。
vtbl 18 HRESULT get_Recipient(IFaxRecipient** ppFaxRecipient)

IFaxOutgoingMessage::get_Recipient プロパティは、FAX メッセージの受信者に関する情報を含むインターフェイスを取得します。

ppFaxRecipientIFaxRecipient**out受信者情報を表すIFaxRecipientインターフェイスを受け取るポインタ。
vtbl 19 HRESULT get_DeviceName(LPWSTR* pbstrDeviceName)

IFaxOutgoingMessage::get_DeviceName プロパティは、FAX メッセージが送信されたデバイスの名前を格納する null 終端文字列です。

pbstrDeviceNameLPWSTR*out送信に使われたファクスデバイス名を受け取るBSTR文字列ポインタ。

解説(Remarks)

このメソッドは、デバイス ID ではなく FAX デバイスの名前を返します。管理者が FAX ジョブの完了後、クライアントが FAX メッセージのアーカイブを照会する前にデバイス ID を削除する場合があるため、これは有用です。

vtbl 20 HRESULT get_TransmissionStart(DOUBLE* pdateTransmissionStart)

IFaxOutgoingMessage::get_TransmissionStart プロパティは、送信 FAX メッセージの送信が開始された時刻を示します。

pdateTransmissionStartDOUBLE*out伝送開始日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 21 HRESULT get_TransmissionEnd(DOUBLE* pdateTransmissionEnd)

IFaxOutgoingMessage::get_TransmissionEnd プロパティは、送信 FAX メッセージの送信が完了した時刻を示します。

pdateTransmissionEndDOUBLE*out伝送終了日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 22 HRESULT get_CSID(LPWSTR* pbstrCSID)

IFaxOutgoingMessage::get_CSID プロパティは、FAX メッセージの着信側局識別子 (CSID: called station identifier) を格納する null 終端文字列です。

pbstrCSIDLPWSTR*out相手側の被呼局識別(CSID)文字列を受け取るBSTRポインタ。
vtbl 23 HRESULT get_TSID(LPWSTR* pbstrTSID)

IFaxOutgoingMessage::get_TSID プロパティは、送信 FAX メッセージに関連付けられた送信側局識別子 (TSID: transmitting station identifier) を格納する null 終端文字列です。

pbstrTSIDLPWSTR*out自局の送信局識別(TSID)文字列を受け取るBSTRポインタ。
vtbl 24 HRESULT CopyTiff(LPWSTR bstrTiffPath)

IFaxOutgoingMessage::CopyTiff メソッドは、送信 FAX メッセージに関連付けられた Tagged Image File Format Class F (TIFF Class F) ファイルを、ローカル コンピューター上のファイルへコピーします。

bstrTiffPathLPWSTRinローカル コンピューター上の完全修飾パスとファイル名を格納する null 終端文字列です。FAX サービスは、送信 FAX メッセージに関連付けられた TIFF Class F ファイルを、ローカル コンピューター上のこのファイルへコピーします。

戻り値

型: HRESULT

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

解説(Remarks)

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

farSUBMIT_LOW アクセス権では、ユーザーは自分自身の FAX に対してのみこのメソッドを使用できます。farMANAGE_OUT_ARCHIVE アクセス権では、サーバー上のすべての FAX に対してこのメソッドを使用できます。

vtbl 25 HRESULT Delete()

IFaxOutgoingMessage::Delete メソッドは、送信アーカイブから FAX メッセージを削除します。

戻り値

型: HRESULT

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

解説(Remarks)

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

farSUBMIT_LOW アクセス権では、ユーザーは自分自身の FAX に対してのみこのメソッドを使用できます。farMANAGE_OUT_ARCHIVE アクセス権では、サーバー上のすべての FAX に対してこのメソッドを使用できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxOutgoingMessage "{F0EA35DE-CAA5-4A7C-82C7-2B60BA5F2BE2}"
#usecom global IFaxOutgoingMessage IID_IFaxOutgoingMessage "{}"
#comfunc global IFaxOutgoingMessage_get_SubmissionId           7 var
#comfunc global IFaxOutgoingMessage_get_Id                     8 var
#comfunc global IFaxOutgoingMessage_get_Subject                9 var
#comfunc global IFaxOutgoingMessage_get_DocumentName           10 var
#comfunc global IFaxOutgoingMessage_get_Retries                11 var
#comfunc global IFaxOutgoingMessage_get_Pages                  12 var
#comfunc global IFaxOutgoingMessage_get_Size                   13 var
#comfunc global IFaxOutgoingMessage_get_OriginalScheduledTime  14 var
#comfunc global IFaxOutgoingMessage_get_SubmissionTime         15 var
#comfunc global IFaxOutgoingMessage_get_Priority               16 var
#comfunc global IFaxOutgoingMessage_get_Sender                 17 sptr
#comfunc global IFaxOutgoingMessage_get_Recipient              18 sptr
#comfunc global IFaxOutgoingMessage_get_DeviceName             19 var
#comfunc global IFaxOutgoingMessage_get_TransmissionStart      20 var
#comfunc global IFaxOutgoingMessage_get_TransmissionEnd        21 var
#comfunc global IFaxOutgoingMessage_get_CSID                   22 var
#comfunc global IFaxOutgoingMessage_get_TSID                   23 var
#comfunc global IFaxOutgoingMessage_CopyTiff                   24 wstr
#comfunc global IFaxOutgoingMessage_Delete                     25
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。