wiasSetPropChanged function (wiamdef.h)

Article
02/22/2024

The wiasSetPropChanged function modifies a property context to indicate that a property is being changed.

Syntax

HRESULT wiasSetPropChanged(
       PROPID               propid,
  [in] WIA_PROPERTY_CONTEXT *pContext,
       BOOL                 bChanged
);

Parameters

propid

Specifies the property identifier of the property being changed.

[in] pContext

Pointer to a WIA_PROPERTY_CONTEXT structure that contains the current property context.

bChanged

Specifies the BOOL value that is used to set a particular element in the array pointed to by the pChanged member of a WIA_PROPERTY_CONTEXT structure. See the Remarks section for more details.

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

The pChanged member of the WIA_PROPERTY_CONTEXT structure points to an array of BOOL values that indicate whether a particular property will be changed. This function sets one element in that array for the specified property in the property context. This function should be used whenever a driver changes a property that has dependent properties in validation. For example, by changing "Current Intent", the "Horizontal Resolution" is changed and should be marked as changed, so that validation of "X Resolution" (WIA_IPS_XRES)and its dependents still takes place.

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