wiasReadPropFloat function (wiamdef.h)

The wiasReadPropFloat function retrieves a floating-point property value from a WIA item.

Syntax

HRESULT wiasReadPropFloat(
  [in]            BYTE   *pWiasContext,
                  PROPID propid,
  [out]           FLOAT  *pfVal,
  [out, optional] FLOAT  *pfValOld,
                  BOOL   bMustExist
);

Parameters

[in] pWiasContext

Pointer to a WIA item context.

propid

Specifies the property identifier.

[out] pfVal

Pointer to a memory location that receives the floating-point value of the property.

[out, optional] pfValOld

Pointer to a memory location that receives the former floating-point value of the property. If this information is not needed, set this parameter to NULL.

bMustExist

Indicates whether the property must exist. If set to TRUE, the property must exist; if set to FALSE, it does not have to exist.

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

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

wiasReadPropBin

wiasReadPropGuid

wiasReadPropLong

wiasReadPropStr

wiasWritePropFloat