SetForm 関数

  • [アーティクル]

SetForm 関数は、指定したプリンターのフォーム情報を設定します。

構文

BOOL SetForm(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pFormName,
  _In_ DWORD  Level,
  _In_ LPTSTR pForm
);

パラメーター

hPrinter [in]

フォーム情報が設定されているプリンターのハンドル。 プリンター ハンドルを取得するには 、OpenPrinter または AddPrinter 関数を使用します。

pFormName [in]

フォーム情報が設定されるフォーム名を指定する null で終わる文字列へのポインター。

レベル [入力]

pForm が指す構造体のバージョン。 この値は 1 または 2 である必要があります。

pForm [in]

FORM_INFO_1またはFORM_INFO_2構造体へのポインター。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。

解説

Note

これはブロック関数または同期関数であり、すぐには返されない可能性があります。 この関数が返す速度は、ネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因など、アプリケーションの作成時に予測が困難な実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。

既存のFORM_INFO_2に対して SetForm を複数回呼び出し、各呼び出しで pDisplayName と wLangId 値のペアを追加できます。 フォームのすべての言語バージョンでは、SetForm の最新の呼び出しで、FORM_INFO_2の Size 値と ImageableArea 値が取得されます。

呼び出し元がリモートで Level が 2 の場合、FORM_INFO_2の StringType 値をSTRING_MUIDLLすることはできません。

要件

要件 値
サポートされている最小のクライアント
 Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー
Winspool.h (Windows.h を含む)
ライブラリ
Winspool.lib
[DLL]
Winspool.drv
Unicode 名と ANSI 名
 SetFormW (Unicode) と SetFormA (ANSI)

関連項目

印刷

印刷スプーラー API 関数

GetForm

OpenPrinter

FORM_INFO_1

FORM_INFO_2