GetForm 関数

  • [アーティクル]

GetForm 関数は、指定したフォームに関する情報を取得します。

構文

BOOL GetForm(
  _In_  HANDLE  hPrinter,
  _In_  LPTSTR  pFormName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pForm,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded
);

パラメーター

hPrinter [in]

プリンターへのハンドル。 プリンター ハンドルを取得するには、 OpenPrinter 関数または AddPrinter 関数を使用します。

pFormName [in]

フォームの名前を指定する null で終わる文字列へのポインター。 プリンターでサポートされているフォームの名前を取得するには、 EnumForms 関数を呼び出します。

レベル [入力]

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

pForm [out]

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

cbBuf [in]

pForm 配列のサイズ (バイト単位)。

pcbNeeded [out]

関数が成功した場合にコピーされるバイト数、または cbBuf が小さすぎる場合に必要なバイト数を指定する値へのポインター。

戻り値

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

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

注釈

注意

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

呼び出し元がリモートで Level が 2 の場合、返されるFORM_INFO_2の StringType 値は常にSTRING_LANGPAIRされます。

要件

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

関連項目

印刷

印刷スプーラー API 関数

AddForm

DeleteForm

OpenPrinter

SetForm