AddForm 関数

  • [アーティクル]

AddForm 関数は、指定したプリンターで選択できる使用可能なフォームの一覧にフォームを追加します。

構文

BOOL AddForm(
  _In_ HANDLE hPrinter,
  _In_ DWORD  Level,
  _In_ LPBYTE pForm
);

パラメーター

hPrinter [in]

指定したフォームでの印刷をサポートするプリンターへのハンドル。 プリンター ハンドルを取得するには、 OpenPrinter 関数または AddPrinter 関数を使用します。

レベル [入力]

pForm が指す構造体のレベル。 この値は 1 または 2 である必要があります。

pForm [in]

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

戻り値

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

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

注釈

注意

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

アプリケーションは、 EnumForms 関数を呼び出すことによって、プリンターで使用できるフォームを決定できます。

pForm がFORM_INFO_2を指している場合、指定した名前のフォームが既に存在するか、構造体の pKeyword 値が既に存在する場合、AddForm は失敗します。

要件

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

関連項目

印刷

印刷スプーラー API 関数

EnumForms

FORM_INFO_1

FORM_INFO_2

OpenPrinter