LWia::SetPropertyLong

#include "ltwrappr.h"

virtual L_INT LWia::SetPropertyLong(pItem, pszID, uID, lValue)

Sets the Long value for any WIA property of the following types: VT_I1, VT_UI1, VT_I2, VT_UI2, VT_I4, VT_UI4, VT_INT, VT_UINT, VT_R4 and VT_R8.

Parameters

L_VOID * pItem

Valid pointer to a type IWiaItem (WIA Version 1.0) or IWiaItem2 (WIA Version 2.0) object, representing the item that is having the property.

Retrieve this parameter by either calling the LWia::GetRootItem function to get a pointer to the device's root item, or by enumerating the child items of the device by calling LWia::EnumChildItems.

L_TCHAR * pszID

String pointer containing the equivalent property ID string for the WIA property ID (see example below):

Property ID Property ID Equivalent String
WIA_IPA_TYMED WIA_IPA_TYMED_STR or "Media Type"
WIA_IPA_DEPTH WIA_IPA_DEPTH_STR or "Bits Per Pixel"

If this parameter is NULL, the WIA toolkit will use the ID passed through the uID parameter; otherwise, the pszID parameter will be used regardless of whether you pass a valid property ID through the uID parameter.

L_UINT32 uID

The property ID of the property.

The uID parameter is required only if the pszID parameter is NULL. If the pszID parameter is not NULL, you can pass 0 for uID.

L_INT32 lValue

Variable containing the Long value needed for the specified property ID and for the specified item.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

This feature is available in LEADTOOLS version 16 or higher.

Call [LWia:SetPropertyLong to set the Long value for any WIA property of the types mentioned above (WIA_DPS_DOCUMENT_HANDLING_SELECT, WIA_IPA_TYMED, etc.)

Microsoft WIA 2.0 Limitation

To customize the Image Data Type property (WIA_IPA_DATATYPE), some drivers using WIA 2.0 require the WIA_IPS_CUR_INTENT property value to be set to WIA_INTENT_NONE.

Required DLLs and Libraries

Help Version 21.0.2021.7.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS WIA C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.