Método IPrintCoreHelperPS::GetOptionAttribute (prcomoem.h)

Artículo
08/07/2023

El método IPrintCoreHelperPS::GetOptionAttribute recupera la lista de atributos de opción o el valor de un atributo de opción específico.

Sintaxis

HRESULT GetOptionAttribute(
  [in]  PCSTR  pszFeatureKeyword,
  [in]  PCSTR  pszOptionKeyword,
  [in]  PCSTR  pszAttribute,
  [out] PDWORD pdwDataType,
  [out] PBYTE  *ppbData,
  [out] PDWORD pcbSize
);

Parámetros

[in] pszFeatureKeyword

Puntero a un búfer proporcionado por el autor de la llamada que contiene una cadena ANSI que especifica la palabra clave de característica para la que se va a consultar.

[in] pszOptionKeyword

Puntero a un búfer proporcionado por el autor de la llamada que contiene una cadena ANSI que especifica la palabra clave option que se va a consultar. Este valor se puede obtener de una llamada anterior a IPrintCoreHelperPS::EnumOptions.

[in] pszAttribute

Puntero a un búfer proporcionado por el autor de la llamada que contiene una cadena ANSI que especifica el atributo solicitado. Si este parámetro es NULL, el autor de la llamada solicita una lista de todos los nombres de atributo admitidos para la opción en lugar de especificar un nombre de atributo específico para la opción.

[out] pdwDataType

Puntero a una variable que recibe un valor que especifica el tipo de datos del atributo solicitado. Este valor es un enumerador del tipo de enumeración EATTRIBUTE_DATATYPE , que se define en printoem.h.

[out] ppbData

Puntero a un búfer asignado por el destinatario que contiene los datos solicitados. Tras la finalización de este método, el autor de la llamada no necesita liberar este búfer.

[out] pcbSize

Puntero a una variable que recibe el tamaño, en bytes, del búfer al que apunta el parámetro pbData .

Valor devuelto

IPrintCoreHelperPS::GetOptionAttribute debe devolver uno de los valores siguientes.

Código devuelto	Descripción
S_OK	El método se ha llevado a cabo de forma correcta.
E_FAIL	Error en el método.
E_INVALIDARG	El método intentó consultar un atributo inexistente. Este valor también puede significar que el nombre de la palabra clave de característica o el nombre de palabra clave de opción no se han reconocido.
E_OUTOFMEMORY	El valor de pcbSize era menor que el número de bytes que se van a escribir en el búfer de salida al que apunta pbData.

Comentarios

Si se llama a IPrintCoreHelperPS::GetOptionAttributecon sus parámetros pszAttribute y pbData establecidos en NULL, el método devuelve con pcbSize establecido en el número de bytes necesarios para la lista de todos los nombres de atributo admitidos para la opción. Si se llama a este método una segunda vez, con pszAttribute establecido en NULL y pbData que apunta a un búfer del tamaño especificado en pcbSize en la llamada anterior, el método devuelve con pdwDataType establecido en kADT_ASCII (un enumerador del tipo de enumeración EATTRIBUTE_DATATYPE ) y pbData que apunta a una lista delimitada por NULL de todos los nombres de atributo admitidos para la opción. Esta lista finaliza con dos caracteres NULL.