Purpose:
This API can be used to retrieve a value of a property identified by its property identifier. The
value type retrieved depends on the property.
Arguments:
[in]hProperty is the handle to access to the properties
[in]dwPropertyID is the property identifier the value needs to be retrieved.
[out]lpValue is a valid pointer to the property value to retrieve.
[in/out]pdwValueSize contains the size of available memory pointed by the lpValue pointer before
calling this API, and contains the final size of the values pointed by lpValue after returning from
this API call.
Returns:
SR_SUCCESS when the property value has been successfully retrieved.
SR_INVALID_PARAMETERS if the hProperty is not a valid property handle or if the property is not a
property that can be read or if the value size doesn’t match with the property value size or if the
property identifier is unknown.
8.30
S
CAN
S
ET
S
CANNER
P
ROPERTY
Prototype:
SCANAPI_API SCAN_RESULT ScanSetScannerProperty(HANDLE hProperty,DWORD
dwPropertyID,LPVOID lpValue,DWORD dwValueSize,BOOL bUpdateScannerIfPresent);
Purpose:
This API can be used to modified a value of a property identified by its identifier. Not all
properties are modifiable.
Arguments:
[in] hProperty: handle to access the properties to modify.
[in] dwPropertyID: identifier of the property to modify.
[in] lpValue: pointer to the new value of the property.
[in] dwValueSize: size of the new value of the property.
[in] bUpdateScannerIfPresent: indicator to update the scanner with the new property value if the
scanner is effectively connected or plugged in to the host computer.
Returns:
SR_SUCCESS if the property has been correctly modified.
SR_INVALID_PARAMETERS if the property handle is invalid or the property cannot be written or if
the value size doesn’t match with the property value size or if the property identifier is unknown.
8.31
P
ROPERTY IDENTIFIERS
Here is the list of the properties that can be read or written with their value type.
SCAN_PROP_ID_PRODUCT_VERSION
Purpose: Contains the product version.
Value type: DWORD.
Operation available: Read Only.
April 8, 2010
Page 54
Document#: 6410-00147 K
Revision 2.28
