Edit

Share via

IPrintCorePS2::EnumOptions method (prcomoem.h)

  • Article

The IPrintCorePS2::EnumOptions method enumerates the available options of a specific feature.

Syntax

HRESULT EnumOptions(
  [in]  PDEVOBJ pdevobj,
  [in]  DWORD   dwFlags,
  [in]  PCSTR   pszFeatureKeyword,
  [out] PSTR    pmszOptionList,
  [in]  DWORD   cbSize,
  [out] PDWORD  pcbNeeded
);

Parameters

[in] pdevobj

Pointer to a DEVOBJ structure.

[in] dwFlags

Is reserved and must be set to zero.

[in] pszFeatureKeyword

Pointer to a caller-supplied buffer containing an ASCII string, specifying a feature keyword whose options are requested.

[out] pmszOptionList

Pointer to a caller-supplied buffer that receives a null-delimited list, in MULTI_SZ format, containing the option keywords for the feature keyword pointed to by pszFeatureKeyword. This list is terminated with two null characters.

Set this parameter to NULL to simply query for the size (*pcbNeeded) of the option list without having the list filled in.

[in] cbSize

Specifies the size, in bytes, of the buffer pointed to by pmszOptionList.

[out] pcbNeeded

Pointer to a memory location that receives the actual size, in bytes, of the requested data.

Return value

This method must return one of the following values.

Return code Description
S_OK
 The method succeeded.
E_OUTOFMEMORY
 The value in cbSize was smaller than the number of bytes to be written to the output buffer (the buffer pointed to by pmszOptionList).

The method was called with pmszOptionList set to NULL.
E_INVALIDARG
 The string pointed to by pszFeatureKeyword is not a recognized feature.

The pdevobj parameter pointed to an invalid driver context object.
E_NOTIMPL
 (Pscript only)

The Pscript5 driver feature is not supported under the current configuration.

The Pscript5 driver feature is supported under the current configuration, but the Pscript5 driver feature's options are not enumerable.
E_FAIL
 The method failed.

Remarks

To reduce the need to make two calls per data access, pass the method an output buffer of a fixed size (1 KB, for example), and then check the function return value. If the method returns S_OK, the buffer already contains the data of interest. If the method returns E_OUTOFMEMORY, the value in *pcbNeeded is the buffer size needed to hold the data of interest. The caller should then allocate a buffer of that larger size and proceed with a second call to the method.

This method is supported for any Pscript5 render plug-in.

For more information, see Using EnumOptions.

Requirements

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

See also

DEVOBJ

IPrintCorePS2

IPrintCorePS2::EnumFeatures