SHInvokePrinterCommandW 関数 (shellapi.h)

[アーティクル]
11/20/2024

プリンターオブジェクトに対してコマンドを実行します。

注この関数は、Windows Vista の時点で非推奨になりました。その代わりに、IContextMenu または ShellExecuteを使用してプリンターで動詞を呼び出することをお勧めします。

構文

BOOL SHInvokePrinterCommandW(
  [in, optional] HWND    hwnd,
                 UINT    uAction,
  [in]           LPCWSTR lpBuf1,
  [in, optional] LPCWSTR lpBuf2,
                 BOOL    fModal
);

パラメーター

[in, optional] hwnd

型: HWND

操作中に作成されるウィンドウまたはダイアログボックスの親ウィンドウのハンドル。

uAction

型: UINT

実行するプリンター操作の種類。次のいずれかの値を指定します。

PRINTACTION_OPEN (0)

0x0。 lpBuf1で指定されたプリンター開きます。 lpBuf2 パラメーターは無視されます。

PRINTACTION_PROPERTIES (1)

0x1。 lpBuf1で指定されたプリンターのプロパティページ表示します。 lpBuf2 パラメーターは、NULL することも、表示する特定のプロパティシートに名前を付けることもできます。名前または数値で指定することもできます。 lpBuf2 の上位 WORD 0 以外の場合、このパラメーターは開くシートの名前を含むバッファーへのポインターであると見なされます。それ以外の場合、lpBuf2 は、開くプロパティシートの 0 から始まるインデックスと見なされます。

PRINTACTION_NETINSTALL (2)

0x2。 lpBuf1で指定されたネットワークプリンターインストールします。 lpBuf2 パラメーターは無視されます。

PRINTACTION_NETINSTALLLINK (3)

0x3。 lpBuf1で指定されたネットワークプリンターショートカットを作成します。 lpBuf2 パラメーターは、ショートカットを作成するフォルダーのドライブとパスを指定します。ネットワークプリンターは、ローカルコンピューターに既にインストールされている必要があります。

PRINTACTION_TESTPAGE (4)

0x4。 lpBuf1で指定されたプリンターにテスト・ページ印刷します。 lpBuf2 パラメーターは無視されます。

PRINTACTION_OPENNETPRN (5)

0x5。 lpBuf1で指定されたネットワークプリンター開きます。 lpBuf2 パラメーターは無視されます。

PRINTACTION_DOCUMENTDEFAULTS (6)

0x6。 lpBuf1で指定されたプリンターの既定のドキュメントプロパティ表示します。 lpBuf2 パラメーターは無視されます。

PRINTACTION_SERVERPROPERTIES (7)

0x7。 lpBuf1で指定されたプリンター・サーバープロパティーを表示します。 lpBuf2 パラメーターは無視されます。

[in] lpBuf1

型: LPCTSTR

プリンターコマンドの追加情報を含む null で終わる文字列へのポインター。このパラメーターに含まれる情報は、uActionの値依存します。

[in, optional] lpBuf2

型: LPCTSTR

プリンターコマンドの追加情報を含む null で終わる文字列へのポインター。このパラメーターに含まれる情報は、uActionの値依存します。

fModal

型: BOOL

コマンドが完了するまで、SHInvokePrinterCommand が返されないように指定する TRUE。コマンドが初期化されるとすぐに関数が戻る必要がある場合は、FALSE をします。

戻り値

型: BOOL

成功した場合 TRUE を返します。それ以外の場合は、FALSEをします。

備考

lpBuf1でプリンター名指定した場合、その名前はローカル・プリンターの名前またはサーバーの名前、およびネットワーク・プリンターの共用名のいずれかになります。ネットワークプリンター名を指定する場合、名前は次の形式で指定する必要があります。

"\\<server><shared printer name>"

この関数は、Shell バージョン 4.71 以降で実装されています。以前のシェルバージョンとの下位互換性を維持するために、この関数を明示的に使用しないでください。代わりに、LoadLibrary と GetProcAddress 関数関数アドレスを取得する必要があります。

手記

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SHInvokePrinterCommand を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional、Windows XP [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	shellapi.h
ライブラリ	Shell32.lib
DLL	Shell32.dll (バージョン 4.71 以降)

次の方法で共有