IPrintCoreHelperPS::GetGlobalAttribute method (prcomoem.h)

Article
08/19/2022

The IPrintCoreHelperPS::GetGlobalAttribute method retrieves the global attribute list or the value of a specific global attribute.

Syntax

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

Parameters

[in] pszAttribute

A pointer to a caller-supplied buffer that contains an ANSI string that specifies the requested attribute. If this parameter is NULL, the caller is requesting a list of all of the supported global attribute names instead of specifying a specific global attribute name.

[out] pdwDataType

A pointer to variable that receives a value that specifies the data type of the requested attribute. This value is an enumerator of the EATTRIBUTE_DATATYPE enumeration type, which is defined in printoem.h.

[out] ppbData

A pointer to a callee-allocated buffer containing the requested data. Upon completion of this method, the caller does not need to release this buffer.

[out] pcbSize

A pointer to a variable that specifies the size, in bytes, of the buffer that is pointed to by the pbData parameter.

Return value

IPrintCoreHelperPS::GetGlobalAttribute should return one of the following values.

Return code	Description
S_OK	The method succeeded.
E_FAIL	The method failed.
E_INVALIDARG	The method attempted to query for a nonexistent attribute.
E_OUTOFMEMORY	The value in pcbSize was smaller than the number of bytes to be written to the output buffer that is pointed to by pbData.

Remarks

If IPrintCoreHelperPS::GetGlobalAttribute is called with its pszAttribute and pbData parameters set to NULL, the method returns with pcbSize set to the number of bytes that are needed for the list of all of the supported global attribute names. If this method is called a second time, with pszAttribute set to NULL and pbData pointing to a buffer of the size that was specified in pcbSize in the previous call, the method returns with pdwDataType set to kADT_ASCII (an enumerator of the EATTRIBUTE_DATATYPE enumeration type) and pbData pointing to a NULL-delimited list of all of the supported global attribute names. This list is terminated with two null characters.

For more information about IPrintCoreHelperPS::GetGlobalAttribute, see Using GetGlobalAttribute.

Requirements

Requirement	Value
Target Platform	Desktop
Header	prcomoem.h (include Prcomoem.h)