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 終止字串的指標，指定要擷取之值的索引鍵。 使用反斜線 ( \ ) 字元做為分隔符號來指定具有一或多個子機碼的路徑。

如果 hPrinter 是印表機的控制碼，且 pKeyName 為 Null 或空字串， GetPrinterDataEx 會傳回 ERROR_INVALID_PARAMETER。

如果 hPrinter 是列印伺服器的控制碼，則會忽略 pKeyName 。

pValueName [in]

識別要擷取之資料的 Null 終止字串指標。

對於印表機，此字串會指定 pKeyName 機碼下的值名稱。

對於列印伺服器，此字串是下列一節所列的其中一個預先定義字串。

pType [out]

變數的指標，可接收儲存在 值中的資料型別。 函式會在儲存資料時傳回 SetPrinterDataEx 呼叫中指定的類型。 如果您不需要資訊，此參數可以是 Null 。 GetPrinterDataEx會將pType傳遞為RegQueryValueEx函式呼叫的lpdwType參數。

pData [out]

接收組態資料的緩衝區指標。

nSize [in]

pData所指向之緩衝區的大小，以位元組為單位。

azureNeeded [out]

接收組態資料大小之變數的指標，以位元組為單位。 如果 nSize 指定的緩衝區大小太小，則函式會傳回 ERROR_MORE_DATA， 而ERROR_MORE_DATA，而eded 表示所需的緩衝區大小。

傳回值

如果函式成功，傳回值 會ERROR_SUCCESS。

如果函式失敗，則傳回值是錯誤值。

備註

GetPrinterDataEx 會擷取 SetPrinterDataEx 和 SetPrinterData 函式所設定的印表機組態資料。

呼叫 GetPrinterDataEx 並將 pKeyName 參數設定為 「PrinterDriverData」 相當於呼叫 GetPrinterData 函式。

如果 hPrinter 是列印伺服器的控制碼， pValueName 可以指定下列其中一個預先定義的值。

pValueName的下列值指出發生錯誤時的集區列印行為。

SPLREG_RESTART_JOB_ON_POOL_ERROR中指定的時間是最短的時間。 根據下列埠監視器設定而定，實際時間可能較長，這些設定是此登錄機碼下的登錄值：

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

呼叫 RegQueryValueEx 函式來查詢這些值。

如果 pKeyName 是其中一個預先定義的目錄服務 (DS) 索引鍵 (，請參閱 SetPrinter) ，且 pValueName 包含逗號 ('，') ，則逗號前面的 pValueName 部分是值名稱，而逗號右邊的 pValueName 部分是 DS 屬性 OID。 系統會建立名為 OID 的子機碼，並建立包含值名稱的新值，並在 OID 機碼下輸入 OID。 SetPrinterDataEx 也會在 DS 索引鍵下新增值名稱和資料。

在 Windows 7 和更新版本的 Windows 中，預設會在用戶端上轉譯傳送至列印伺服器的列印工作。 您可以將 pKeyName 設定為 「PrinterDriverData」， 並將 pValueName 設定為下表中的設定值，即可讀取印表機的用戶端轉譯。

規格需求

另請參閱

列印

列印多工緩衝處理器 API 函式

OpenPrinter

SetPrinterDataEx