Metodo IPrintCoreHelperPS::GetOption (prcomoem.h)

Articolo
08/07/2023

Il metodo IPrintCoreHelperPS::GetOption ottiene un'opzione specificata per una determinata funzionalità.

Sintassi

HRESULT GetOption(
  [in, optional] const DEVMODE *pDevmode,
  [in]           DWORD         cbSize,
  [in]           PCSTR         pszFeatureRequested,
  [out]          PCSTR         *ppszOption
);

Parametri

[in, optional] pDevmode

Puntatore a una struttura DEVMODEW. Se viene fornito questo puntatore, IPrintCoreHelperPS::GetOption deve usare la struttura DEVMODEW a cui punta pDevmode anziché la struttura DEVMODEW predefinita o corrente. Se questo metodo viene chiamato dal provider plug-in o da IPrintOemPS::D evMode, questo parametro è obbligatorio. Nella maggior parte delle altre situazioni, il parametro deve essere NULL. Quando il driver di base imposta pDevmode su NULL, modifica lo stato interno anziché quello della struttura DEVMODEW passata. Questa operazione è necessaria durante operazioni come la sostituzione completa dell'interfaccia utente, in cui la struttura DEVMODEW restituita da un DDI, ad esempio DrvDocumentPropertySheets, viene eseguita dal modulo dell'interfaccia utente del driver principale.

[in] cbSize

Dimensioni, in byte, della struttura DEVMODEW a cui punta il parametro pDevmode .

[in] pszFeatureRequested

Puntatore alla stringa ANSI contenente il nome della funzionalità come viene visualizzato nel file PPD.

[out] ppszOption

Puntatore a una variabile contenente l'indirizzo di una stringa ANSI. Quando IPrintCoreHelperPS::GetOption restituisce, la stringa deve contenere la parola chiave per l'opzione attualmente selezionata come viene visualizzata nel file di configurazione. Il chiamante non deve modificare questa stringa e non deve liberare la memoria associata a questa stringa.

Valore restituito

IPrintCoreHelperPS::GetOption deve restituire uno dei valori seguenti.

Codice restituito	Descrizione
S_OK	Il metodo legge l'opzione per la funzionalità specificata.
E_FAIL	Il chiamante ha fornito informazioni che hanno generato una richiesta non valida. Ad esempio, la funzionalità richiesta non esiste.
E_INVALIDARG	Gli argomenti non sono validi. Questo valore potrebbe significare che la funzionalità non è supportata o che sono state richieste troppe opzioni per la funzionalità.
E_OUTOFMEMORY	Il driver di base non è stato in grado di eseguire il servizio della richiesta perché era presente memoria insufficiente.
E_UNEXPECTED o altri codici restituiti non elencati qui	Il driver di base sembra essere in uno stato non valido. Il chiamante deve restituire un codice di errore.

Commenti

Impossibile usare IPrintCoreHelperPS::GetOption per le funzionalità che consentono l'impostazione simultanea di più opzioni.

Le parole chiave delle funzionalità sono definite nel file PPD. Inoltre, il driver Pscript5 supporta diverse parole chiave riservate per le opzioni archiviate nella struttura DEVMODEWprivata. Per l'elenco delle funzionalità Pscript5, vedere Mapping delle parole chiave.

Il chiamante non deve liberare la stringa a cui fa riferimento ppszOption e non deve modificare la stringa in alcun modo.