EngGetForm 関数 (winddi.h)

EngGetForm 関数は、指定したフォームのFORM_INFO_1の詳細を取得します。

構文

ENGAPI BOOL EngGetForm(
  [in]           HANDLE  hPrinter,
  [in]           LPWSTR  pFormName,
  [in]           DWORD   Level,
  [in, optional] LPBYTE  pForm,
  [in]           DWORD   cbBuf,
  [out]          LPDWORD pcbNeeded
);

パラメーター

[in] hPrinter

フォームが指定されているプリンターを処理します。

[in] pFormName

フォームの名前を指定する文字列へのポインター。

[in] Level

pForm が指すフォーム構造のバージョンを指定します。 この値は 1 である必要があります。これは、フォーム情報がFORM_INFO_1構造体で返されることを示します。

[in, optional] pForm

初期化されたFORM_INFO_1構造体を受け取るバイト配列へのポインター。

[in] cbBuf

pForm のサイズをバイト単位で指定します。

[out] pcbNeeded

関数が成功した場合に pForm によって指されるバッファーにコピーされるバイト数を指定する値へのポインター。 値は、 cbBuf が小さすぎる場合にコピーを実行するために必要なバイト数です。

戻り値

フォーム構造が pForm に正常にコピーされた場合、EngGetForm は TRUE を返します。 それ以外の場合は、エラー メッセージをログに記録し、 FALSE を返します。 エラー情報を取得するには、 EngGetLastError を呼び出します。

注釈

EngGetForm は、pFormName に関連付けられたフォーム データを含むFORM_INFO_1構造体 (Microsoft Windows SDK ドキュメントで説明) を返します。 書き込まれたデータとそのサイズは、それぞれ pForm と pcbNeeded を介して呼び出し元に返されます。 pForm が指す配列がフォーム データを保持するのに十分な大きさでない場合、必要な配列サイズは代わりに pcbNeeded で返されます。

サポートされているすべてのフォームの一覧を取得するには、プリンター ドライバーで EngEnumForms を呼び出す必要があります。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 以降のバージョンの Windows オペレーティング システムで使用できます。
対象プラットフォーム	ユニバーサル
Header	winddi.h (Winddi.h を含む)
Library	Win32k.lib
[DLL]	Win32k.sys

こちらもご覧ください

EngEnumForms

EngGetLastError