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

IFaxOutgoingJob

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID6356daad-6614-4583-bf7a-3ad67bbfc71c継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

メソッド 31

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

vtbl 7 HRESULT get_Subject(LPWSTR* pbstrSubject)
pbstrSubjectLPWSTR*out送信ジョブの件名を受け取るBSTR文字列ポインタ。呼出側で解放する。
vtbl 8 HRESULT get_DocumentName(LPWSTR* pbstrDocumentName)
pbstrDocumentNameLPWSTR*out送信ジョブの元ドキュメント名を受け取るBSTR文字列ポインタ。
vtbl 9 HRESULT get_Pages(INT* plPages)
plPagesINT*out送信ジョブの総ページ数を受け取るINTポインタ。
vtbl 10 HRESULT get_Size(INT* plSize)
plSizeINT*out送信ジョブのサイズ(バイト単位)を受け取るINTポインタ。
vtbl 11 HRESULT get_SubmissionId(LPWSTR* pbstrSubmissionId)
pbstrSubmissionIdLPWSTR*out送信要求(サブミッション)を一意に識別するIDを受け取るBSTRポインタ。同報の親IDに相当する。
vtbl 12 HRESULT get_Id(LPWSTR* pbstrId)
pbstrIdLPWSTR*out個別の送信ジョブを一意に識別するIDを受け取るBSTRポインタ。
vtbl 13 HRESULT get_OriginalScheduledTime(DOUBLE* pdateOriginalScheduledTime)
pdateOriginalScheduledTimeDOUBLE*out当初予定されていた送信日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 14 HRESULT get_SubmissionTime(DOUBLE* pdateSubmissionTime)
pdateSubmissionTimeDOUBLE*outジョブが投入された日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 15 HRESULT get_ReceiptType(FAX_RECEIPT_TYPE_ENUM* pReceiptType)
pReceiptTypeFAX_RECEIPT_TYPE_ENUM*out送達通知の方式を表すFAX_RECEIPT_TYPE_ENUM値を受け取るポインタ。メール通知等を示す。
vtbl 16 HRESULT get_Priority(FAX_PRIORITY_TYPE_ENUM* pPriority)
pPriorityFAX_PRIORITY_TYPE_ENUM*out送信ジョブの優先度を表すFAX_PRIORITY_TYPE_ENUM値を受け取るポインタ。低/中/高を示す。
vtbl 17 HRESULT get_Sender(IFaxSender** ppFaxSender)
ppFaxSenderIFaxSender**out送信者情報を表すIFaxSenderインターフェイスを受け取るポインタ。
vtbl 18 HRESULT get_Recipient(IFaxRecipient** ppFaxRecipient)
ppFaxRecipientIFaxRecipient**out受信者情報を表すIFaxRecipientインターフェイスを受け取るポインタ。
vtbl 19 HRESULT get_CurrentPage(INT* plCurrentPage)
plCurrentPageINT*out現在伝送中のページ番号を受け取るINTポインタ。
vtbl 20 HRESULT get_DeviceId(INT* plDeviceId)
plDeviceIdINT*outジョブを処理しているファクスデバイスのIDを受け取るINTポインタ。
vtbl 21 HRESULT get_Status(FAX_JOB_STATUS_ENUM* pStatus)
pStatusFAX_JOB_STATUS_ENUM*out送信ジョブの状態を表すFAX_JOB_STATUS_ENUM値を受け取るポインタ。送信中/完了等を示す。
vtbl 22 HRESULT get_ExtendedStatusCode(FAX_JOB_EXTENDED_STATUS_ENUM* pExtendedStatusCode)
pExtendedStatusCodeFAX_JOB_EXTENDED_STATUS_ENUM*out拡張状態を表すFAX_JOB_EXTENDED_STATUS_ENUM値を受け取るポインタ。詳細な進行状況を示す。
vtbl 23 HRESULT get_ExtendedStatus(LPWSTR* pbstrExtendedStatus)
pbstrExtendedStatusLPWSTR*out拡張状態の説明文字列を受け取るBSTRポインタ。プロバイダ固有の状態記述を含む。
vtbl 24 HRESULT get_AvailableOperations(FAX_JOB_OPERATIONS_ENUM* pAvailableOperations)
pAvailableOperationsFAX_JOB_OPERATIONS_ENUM*out現在実行可能な操作を表すFAX_JOB_OPERATIONS_ENUM値を受け取るポインタ。一時停止/再開/中止等のビット組合せ。
vtbl 25 HRESULT get_Retries(INT* plRetries)
plRetriesINT*outこれまでに行われた送信再試行回数を受け取るINTポインタ。
vtbl 26 HRESULT get_ScheduledTime(DOUBLE* pdateScheduledTime)
pdateScheduledTimeDOUBLE*out現在設定されている送信予定日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 27 HRESULT get_TransmissionStart(DOUBLE* pdateTransmissionStart)
pdateTransmissionStartDOUBLE*out伝送開始日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 28 HRESULT get_TransmissionEnd(DOUBLE* pdateTransmissionEnd)
pdateTransmissionEndDOUBLE*out伝送終了日時をDATE形式で受け取るDOUBLEポインタ。
vtbl 29 HRESULT get_CSID(LPWSTR* pbstrCSID)
pbstrCSIDLPWSTR*out相手側の被呼局識別(CSID)文字列を受け取るBSTRポインタ。
vtbl 30 HRESULT get_TSID(LPWSTR* pbstrTSID)
pbstrTSIDLPWSTR*out自局の送信局識別(TSID)文字列を受け取るBSTRポインタ。
vtbl 31 HRESULT get_GroupBroadcastReceipts(VARIANT_BOOL* pbGroupBroadcastReceipts)
pbGroupBroadcastReceiptsVARIANT_BOOL*out同報送信で受信確認をグループ単位にまとめるかを受け取るVARIANT_BOOLポインタ。
vtbl 32 HRESULT Pause()
vtbl 33 HRESULT Resume()
vtbl 34 HRESULT Restart()
vtbl 35 HRESULT CopyTiff(LPWSTR bstrTiffPath)
bstrTiffPathLPWSTRin送信ジョブのファクス画像をTIFFファイルとして書き出すコピー先パスを指定するBSTR。
vtbl 36 HRESULT Refresh()
vtbl 37 HRESULT Cancel()

HSP用 COM定義

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

出力引数:
#define global IID_IFaxOutgoingJob "{6356DAAD-6614-4583-BF7A-3AD67BBFC71C}"
#usecom global IFaxOutgoingJob IID_IFaxOutgoingJob "{}"
#comfunc global IFaxOutgoingJob_get_Subject                 7 var
#comfunc global IFaxOutgoingJob_get_DocumentName            8 var
#comfunc global IFaxOutgoingJob_get_Pages                   9 var
#comfunc global IFaxOutgoingJob_get_Size                    10 var
#comfunc global IFaxOutgoingJob_get_SubmissionId            11 var
#comfunc global IFaxOutgoingJob_get_Id                      12 var
#comfunc global IFaxOutgoingJob_get_OriginalScheduledTime   13 var
#comfunc global IFaxOutgoingJob_get_SubmissionTime          14 var
#comfunc global IFaxOutgoingJob_get_ReceiptType             15 var
#comfunc global IFaxOutgoingJob_get_Priority                16 var
#comfunc global IFaxOutgoingJob_get_Sender                  17 sptr
#comfunc global IFaxOutgoingJob_get_Recipient               18 sptr
#comfunc global IFaxOutgoingJob_get_CurrentPage             19 var
#comfunc global IFaxOutgoingJob_get_DeviceId                20 var
#comfunc global IFaxOutgoingJob_get_Status                  21 var
#comfunc global IFaxOutgoingJob_get_ExtendedStatusCode      22 var
#comfunc global IFaxOutgoingJob_get_ExtendedStatus          23 var
#comfunc global IFaxOutgoingJob_get_AvailableOperations     24 var
#comfunc global IFaxOutgoingJob_get_Retries                 25 var
#comfunc global IFaxOutgoingJob_get_ScheduledTime           26 var
#comfunc global IFaxOutgoingJob_get_TransmissionStart       27 var
#comfunc global IFaxOutgoingJob_get_TransmissionEnd         28 var
#comfunc global IFaxOutgoingJob_get_CSID                    29 var
#comfunc global IFaxOutgoingJob_get_TSID                    30 var
#comfunc global IFaxOutgoingJob_get_GroupBroadcastReceipts  31 var
#comfunc global IFaxOutgoingJob_Pause                       32
#comfunc global IFaxOutgoingJob_Resume                      33
#comfunc global IFaxOutgoingJob_Restart                     34
#comfunc global IFaxOutgoingJob_CopyTiff                    35 wstr
#comfunc global IFaxOutgoingJob_Refresh                     36
#comfunc global IFaxOutgoingJob_Cancel                      37
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。