wiasGetChangedValueStr function (wiamdef.h)

The wiasGetChangedValueStr function determines whether a property with a string value has been changed by an application.

Syntax

HRESULT wiasGetChangedValueStr(
  [in] BYTE                    *pWiasContext,
  [in] WIA_PROPERTY_CONTEXT    *pContext,
       BOOL                    bNoValidation,
       PROPID                  propID,
       WIAS_CHANGED_VALUE_INFO *pInfo
);

Parameters

[in] pWiasContext

Pointer to a WIA item context.

[in] pContext

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

bNoValidation

Indicates whether the property's current value should be validated against its set of valid values. If this parameter is set to TRUE, the function does not perform validation on the property. If it is FALSE, the function performs data validation.

propID

Specifies the property identifier of the property being tested.

pInfo

Pointer to a WIAS_CHANGED_VALUE_INFO structure that contains the current and previous values of the property.

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

The driver should validate the property only after the driver has updated the values of the property. The driver updates the values as a result of property changes requested by the application.

Requirements

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

See also

WIAS_CHANGED_VALUE_INFO

WIA_PROPERTY_CONTEXT

wiasGetChangedValueFloat

wiasGetChangedValueGuid

wiasGetChangedValueLong