Metodo IPrintCorePS2::GetOptions (prcomoem.h)

Articolo
02/07/2025

Il metodo IPrintCorePS2::GetOptions recupera le impostazioni correnti della funzionalità del driver nel formato di un elenco di coppie di parole chiave feature/option.

Sintassi

HRESULT GetOptions(
  [in]  PDEVOBJ pdevobj,
  [in]  DWORD   dwFlags,
  [in]  PCZZSTR pmszFeaturesRequested,
  [in]  DWORD   cbIn,
  [out] PZZSTR  pmszFeatureOptionBuf,
  [in]  DWORD   cbSize,
  [out] PDWORD  pcbNeeded
);

Parametri

[in] pdevobj

Puntatore a una struttura DEVOBJ.

[in] dwFlags

È riservato e deve essere impostato su zero.

[in] pmszFeaturesRequested

Puntatore al buffer fornito dal chiamante contenente un elenco di parole chiave di funzionalità (in formato MULTI_SZ) le cui impostazioni sono richieste. Impostare questo parametro su NULL per ottenere le impostazioni per tutte le funzionalità.

[in] cbIn

Specifica le dimensioni, in byte, del buffer a cui punta pmszFeaturesRequested. Le dimensioni includono l'ultimo carattere null MULTI_SZ.

[out] pmszFeatureOptionBuf

Puntatore a un buffer fornito dal chiamante che riceve un elenco di coppie di parole chiave feature/option (in formato MULTI_SZ) ottenute dalle impostazioni del driver. Ogni coppia di parole chiave feature/option contiene il nome della parola chiave della funzionalità, un carattere Null, il nome della parola chiave dell'opzione e un altro carattere Null. L'elenco viene terminato da due caratteri NULL.

[in] cbSize

Specifica le dimensioni, in byte, del buffer a cui punta pmszFeatureOptionBuf.

[out] pcbNeeded

Puntatore a una posizione di memoria che riceve le dimensioni effettive, in byte, dei dati richiesti.

Valore restituito

Il metodo deve restituire uno dei valori seguenti.

Codice restituito	Descrizione
S_OK	Il metodo è riuscito.
E_OUTOFMEMORY	Il valore in cbSize è minore del numero di byte da scrivere nel buffer di output (il buffer a cui punta pmszFeatureOptionBuf). Il metodo è stato chiamato con pmszFeatureOptionBuf impostato su NULL.
E_INVALIDARG	Il buffer di input (il buffer a cui punta pmszFeaturesRequested) è stato fornito, ma il relativo contenuto non era in formato MULTI_SZ. Il parametro pdevobj punta a un oggetto contesto driver non valido.
E_NOTIMPL	Il metodo non è supportato.
E_FAIL	Il metodo non è riuscito.

Osservazioni

Questo metodo supporta sia document-sticky che funzionalità di con sticky della stampante. È supportato solo al termine dell'elaborazione del driver principale DrvEnablePDEV, che configura tutte le impostazioni delle opzioni. Una chiamata a IPrintCorePS2::GetOptions quando non è supportata deve restituire E_NOTIMPL. Ad esempio, quando il driver principale chiama un metodo di IPrintOemPS::EnablePDEV di rendering, il driver è ancora occupato con l'elaborazione DrvEnablePDEV, quindi se il plug-in chiama IPrintCorePS2::GetOptions all'interno del IPrintOemPS::D evMode metodo, il plug-in riceve il valore restituito E_NOTIMPL. Tuttavia, poiché il metodo IPrintOemPS::EnablePDEV del plug-in viene chiamato dopo il completamento del driver principale l'elaborazione DrvEnablePDEV, il plug-in è in grado di chiamare correttamente IPrintCorePS2::GetOptions all'interno del relativo metodo IPrintOemPS::EnablePDEV.

Se una parola chiave della funzionalità richiesta non viene riconosciuta o la funzionalità viene riconosciuta ma non è attualmente disponibile alcuna selezione di opzioni, la funzionalità viene ignorata e la coppia di parole chiave feature/option non viene inserita nel buffer di output.

Per ridurre la necessità di effettuare due chiamate per accesso ai dati, passare il metodo un buffer di output di una dimensione fissa (ad esempio 1 KB) e quindi controllare il valore restituito dalla funzione. Se il metodo restituisce S_OK, il buffer contiene già i dati di interesse. Se il metodo restituisce E_OUTOFMEMORY, il valore in * pcbNeeded è la dimensione del buffer necessaria per contenere i dati di interesse. Il chiamante deve quindi allocare un buffer di dimensioni maggiori e procedere con una seconda chiamata al metodo .

Questo metodo è supportato per qualsiasi plug-in di rendering Pscript5.

Per altre informazioni, vedere Using GetOptions and SetOptions.