wiasReadPropLong function (wiamdef.h)

The wiasReadPropLong function retrieves a long integer property value from a WIA item.

Syntax

HRESULT wiasReadPropLong(
  [in]            BYTE   *pWiasContext,
                  PROPID propid,
  [out]           LONG   *plVal,
  [out, optional] LONG   *plValOld,
                  BOOL   bMustExist
);

Parameters

[in] pWiasContext

Pointer to a WIA item context.

propid

Specifies the property identifier.

[out] plVal

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

[out, optional] plValOld

Pointer to a memory location that receives the property's previous value. 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, the property 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

wiasReadPropFloat

wiasReadPropGuid

wiasReadPropStr

wiasWritePropLong