wiasIsPropChanged function (wiamdef.h)

Article
02/22/2024

The wiasIsPropChanged function tests whether a specified property has been changed by an application.

Syntax

HRESULT wiasIsPropChanged(
        PROPID               propid,
  [in]  WIA_PROPERTY_CONTEXT *pContext,
  [out] BOOL                 *pbChanged
);

Parameters

propid

Specifies the property identifier of the property to be checked.

[in] pContext

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

[out] pbChanged

Pointer to a memory location that receives a BOOL value. The BOOL value is TRUE if the property changed, and FALSE if the property did not change.

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 codes.

Remarks

This function determines whether a property is being changed by looking at the bChanged member value in the property's WIA_PROPERTY_CONTEXT structure. Minidrivers typically use this function to check when an independent property has been changed so that its dependents can be updated.

Requirements

Requirement	Value
Target Platform	Desktop
Header	wiamdef.h (include Wiamdef.h)
Library	Wiaservc.lib
DLL	Wiaservc.dll