Win32 API 日本語リファレンス
ホーム › UI.Controls.Dialogs › IPrintDialogServices

IPrintDialogServices

COM
📘 Microsoft Learn (日本語) · English
IID509aaeda-5639-11d1-b6a1-0000f8757bf9継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

PrintDlgEx 関数を使用するアプリケーションが、現在選択されているプリンターに関する情報を取得できるようにするメソッドを提供します。

解説(Remarks)

このプリンターは、Print Property Sheet の [全般] ページにあるインストール済みプリンターの一覧で示されます。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetCurrentDevMode(DEVMODEA* pDevMode, DWORD* pcbSize)

PrintDlgEx で使用するために、現在選択されているプリンターに関する情報で DEVMODE 構造体を埋めます。

pDevModeDEVMODEA*inout現在選択されているプリンターに関する情報を格納した DEVMODE 構造体を受け取るバッファーへのポインター。
pcbSizeDWORD*inout

入力時、この変数は lpDevMode パラメーターが指すバッファーのサイズをバイト単位で指定します。出力時、この変数には lpDevMode に書き込まれたバイト数が格納されます。

入力時にサイズが 0 の場合、関数は必要なバッファーサイズ(バイト単位)を pcbSize に返し、lpDevMode バッファーは使用しません。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は S_OK です。現在選択されているプリンターがない場合、戻り値は S_OK となり、pcbSize に返される値は 0、lpDevMode バッファーは変更されません。

エラーが発生した場合、戻り値は COM エラーコードです。詳細については、Error Handling を参照してください。

vtbl 4 HRESULT GetCurrentPrinterName(LPWSTR pPrinterName, DWORD* pcchSize)

PrintDlgEx で使用するために、現在選択されているプリンターの名前を取得します。

pPrinterNameLPWSTRoutoptional現在選択されているプリンターの名前。
pcchSizeDWORD*inout

入力時、この変数は lpPrinterName パラメーターが指すバッファーのサイズを文字単位で指定します。出力時、この変数には、終端の null 文字を含めてバッファーに書き込まれたバイト数(ANSI)または文字数(Unicode)が格納されます。

入力時にサイズが 0 の場合、関数は必要なバッファーサイズ(バイト単位または文字単位)を pcchSize に返し、lpPrinterName バッファーは使用しません。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は S_OK です。現在選択されているプリンターがない場合、戻り値は S_OK となり、pcchSize に返される値は 0、lpPrinterName バッファーは変更されません。

エラーが発生した場合、戻り値は COM エラーコードです。詳細については、Error Handling を参照してください。

vtbl 5 HRESULT GetCurrentPortName(LPWSTR pPortName, DWORD* pcchSize)

PrintDlgEx で使用するために、現在のポートの名前を取得します。

pPortNameLPWSTRoutoptional現在のポートの名前。
pcchSizeDWORD*inout

入力時、この変数は lpPortName パラメーターが指すバッファーのサイズを文字単位で指定します。出力時、この変数には、終端の null 文字を含めてバッファーに書き込まれたバイト数(ANSI)または文字数(Unicode)が格納されます。

入力時にサイズが 0 の場合、関数は必要なバッファーサイズ(バイト単位または文字単位)を pcchSize に返し、lpPortName バッファーは使用しません。

戻り値

型: HRESULT

メソッドが成功した場合、戻り値は S_OK です。現在のポートがない場合、戻り値は S_OK となり、pcchSize に返される値は 0、lpPortName バッファーは変更されません。

エラーが発生した場合、戻り値は COM エラーコードです。詳細については、Error Handling を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IPrintDialogServices "{509AAEDA-5639-11D1-B6A1-0000F8757BF9}"
#usecom global IPrintDialogServices IID_IPrintDialogServices "{}"
#comfunc global IPrintDialogServices_GetCurrentDevMode      3 var,var
#comfunc global IPrintDialogServices_GetCurrentPrinterName  4 var,var
#comfunc global IPrintDialogServices_GetCurrentPortName     5 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。