The IPrintCoreHelperPS::GetOptionAttribute method retrieves the option attribute list or the value of a specific option attribute.
HRESULT GetOptionAttribute( PCSTR pszFeatureKeyword, PCSTR pszOptionKeyword, PCSTR pszAttribute, PDWORD pdwDataType, PBYTE *ppbData, PDWORD pcbSize );
A pointer to a caller-supplied buffer that contains an ANSI string that specifies the feature keyword to query for.
A pointer to a caller-supplied buffer that contains an ANSI string that specifies the option keyword to query for. This value can be obtained from a prior call to IPrintCoreHelperPS::EnumOptions.
A pointer to a caller-supplied buffer that contains an ANSI string that specifies the attribute requested. If this parameter is NULL, the caller is requesting a list of all supported attribute names for the option instead of specifying a specific attribute name for the option.
A pointer to a 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.
A pointer to a variable that receives the size, in bytes, of the buffer that is pointed to by the pbData parameter.
IPrintCoreHelperPS::GetOptionAttribute should return one of the following values.
||The method succeeded.|
||The method failed.|
The method attempted to query for a nonexistent attribute.
This value might also mean that the feature keyword name or option keyword name were not recognized.
||The value in pcbSize was smaller than the number of bytes to be written to the output buffer that is pointed to by pbData.|
If IPrintCoreHelperPS::GetOptionAttribute 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 attribute names for the option. 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 attribute names for the option. This list is terminated with two null characters.
For more information about IPrintCoreHelperPS::GetOptionAttribute, see Using GetOptionAttribute.
|Header||prcomoem.h (include Prcomoem.h)|