GetPrinterDataEx 関数

GetPrinterDataEx 関数は、指定されたプリンターまたはプリント サーバーの構成データを取得します。 GetPrinterDataEx は、 SetPrinterData 関数が格納した値を取得できます。 さらに、 GetPrinterDataEx は 、SetPrinterDataEx 関数が指定したキーの下に格納した値を取得できます。

構文

DWORD GetPrinterDataEx(
  _In_  HANDLE  hPrinter,
  _In_  LPCTSTR pKeyName,
  _In_  LPCTSTR pValueName,
  _Out_ LPDWORD pType,
  _Out_ LPBYTE  pData,
  _In_  DWORD   nSize,
  _Out_ LPDWORD pcbNeeded
);

パラメーター

hPrinter [in]

関数が構成データを取得するプリンターまたはプリント サーバーへのハンドル。 プリンター ハンドルを取得するには、 OpenPrinter、 OpenPrinter2、または AddPrinter 関数を使用します。

pKeyName [in]

取得する値を含むキーを指定する null で終わる文字列へのポインター。 区切り記号として円記号 ( \ ) 文字を使用して、1 つ以上のサブキーを持つパスを指定します。

hPrinter がプリンターのハンドルで、pKeyName が NULL または空の文字列である場合、GetPrinterDataEx はERROR_INVALID_PARAMETERを返します。

hPrinter がプリント サーバーへのハンドルである場合、pKeyName は無視されます。

pValueName [in]

取得するデータを識別する null で終わる文字列へのポインター。

プリンターの場合、この文字列は pKeyName キーの値の名前を指定します。

プリント サーバーの場合、この文字列は、次の「解説」セクションに記載されている定義済みの文字列の 1 つです。

pType [out]

値に格納されているデータの型を受け取る変数へのポインター。 関数は、データの格納時に SetPrinterDataEx 呼び出しで指定された型を返します。 このパラメーターは、情報が不要な場合は NULL にすることができます。 GetPrinterDataEx は、RegQueryValueEx 関数呼び出しの lpdwType パラメーターとして pType を渡します。

pData [out]

構成データを受け取るバッファーへのポインター。

nSize [in]

pData が指すバッファーのサイズ (バイト単位)。

pcbNeeded [out]

構成データのサイズをバイト単位で受け取る変数へのポインター。 nSize で指定されたバッファー サイズが小さすぎる場合、関数は ERROR_MORE_DATAを返し、pcbNeeded は必要なバッファー サイズを示します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS。

関数が失敗した場合、戻り値はエラー値です。

解説

GetPrinterDataEx は、 SetPrinterDataEx 関数と SetPrinterData 関数によって設定されたプリンター構成データを取得します。

pKeyName パラメーターを "PrinterDriverData" に設定して GetPrinterDataEx を呼び出すことは、GetPrinterData 関数の呼び出しと同じです。

hPrinter がプリント サーバーへのハンドルである場合、pValueName は次の定義済みの値のいずれかを指定できます。

pValueName の次の値は、エラーが発生したときのプールの印刷動作を示します。

SPLREG_RESTART_JOB_ON_POOL_ERRORで指定された時間は最小時間です。 実際の時間は、次のポート モニター設定 (このレジストリ キーの下のレジストリ値) に応じて、長くなる可能性があります。

HKLM\SYSTEM\CurrentControlSet\Control\Print\Monitors\<MonitorName>\Ports

RegQueryValueEx 関数を呼び出して、これらの値に対してクエリを実行します。

pKeyName が定義済みのディレクトリ サービス (DS) キーの 1 つ (SetPrinter を参照) で、pValueName にコンマ (',') が含まれている場合、コンマの前の pValueName の部分は値名であり、コンマの右側にある pValueName の部分は DS Property OID です。 OID と呼ばれるサブキーが作成され、値名と OID で構成される新しい値が OID キーの下に入力されます。 SetPrinterDataEx では 、DS キーの下に値の名前とデータも追加されます。

Windows 7 以降のバージョンの Windows では、プリント サーバーに送信される印刷ジョブは、既定でクライアントにレンダリングされます。 プリンターのクライアント側レンダリングの構成は、 pKeyName を "PrinterDriverData" に設定し、 pValueName を次の表の設定値に設定することで読み取ることができます。

必要条件

関連項目

印刷

印刷スプーラー API 関数

OpenPrinter

SetPrinterDataEx