Edit

Share via

wiasSetPropertyAttributes function (wiamdef.h)

  • Article

The wiasSetPropertyAttributes function sets the access flags and valid values for a set of properties.

Syntax

HRESULT wiasSetPropertyAttributes(
  [in]  BYTE        *pWiasContext,
        LONG        cPropSpec,
  [in]  PROPSPEC    *pPropSpec,
  [in]  ULONG       *pulAccessFlags,
  [out] PROPVARIANT *pPropVar
);

Parameters

[in] pWiasContext

Pointer to a WIA item context.

cPropSpec

Specifies the number of properties.

[in] pPropSpec

Pointer to a PROPSPEC structure indicating the properties for which to set valid values and access flags.

[in] pulAccessFlags

Pointer to an array that contains the access flags to be written.

[out] pPropVar

Pointer to an array of PROPVARIANT structures that contains the valid values to be written.

Return value

On success, the function returns S_OK. If the function fails, it returns a standard COM error or one of the WIA_ERROR_XXX errors (described in the Microsoft Windows SDK documentation).

Remarks

Minidrivers should use the function wiasSetItemPropAttribs to initialize groups of simple properties.

The minidriver can set the WIA_PROP_CACHEABLE flag on a property that does not change over time. By setting this flag on a property, the minidriver indicates that the WIA service can cache the property value. See the Windows SDK documentation for a list of all property attributes.

The PROPSPEC and PROPVARIANT structures are defined in the Windows SDK documentation.

Requirements

Requirement Value
Minimum supported client Available in Microsoft Windows Me and in Windows XP and later versions of the Windows operating systems.
Target Platform Desktop
Header wiamdef.h (include Wiamdef.h)
Library Wiaservc.lib
DLL Wiaservc.dll

See also

wiasSetItemPropAttribs