References ▼
#include "ltwia.h"
L_LTWIA_API L_INT EXT_FUNCTION L_WiaSetPropertyLong(hSession, pItem, pszID, uID, lValue)
HWIASESSION hSession; |
handle to an existing WIA session |
L_VOID* pItem; |
pointer to IWiaItem or IWiaItem2 interface |
L_TCHAR* pszID; |
pointer to string array that represents the equivalent property ID string |
L_UINT32 uID; |
property ID |
L_INT32 lValue; |
variable of type L_INT that represents the Long value to be set for the specified Property ID |
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.
| Parameter | Description | |
| hSession | Handle to an existing WIA session. This handle is obtained by calling the L_WiaInitSession function. | |
| pItem | Valid pointer to a type IWiaItem or IWiaItem2 object (IWiaItem if using WIA Version 1.0; IWiaItem2 if using WIA Version 2.0), which represents the item having the property. | |
| You can retrieve this parameter by either calling the L_WiaGetRootItem function to get a pointer to the device's root item or by enumerating the child items of the device through a call to L_WiaEnumChildItems. | ||
| pszID | This string pointer should contain 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 then the WIA toolkit will use the ID passed through the uID parameter, otherwise the pszID parameter will be used whether or not you passed valid property ID through the uID parameter. | ||
| uID | The property ID of the property. | |
| This parameter is required only if the pszID parameter is NULL, otherwise you can pass 0 for this parameter. | ||
| lValue | Variable that contains the Long value you need to set for the specified property ID and for the specified item. | |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
This feature is available in version 16 or higher.
Call this function to set the Long value for any WIA property of the types mentioned above (for instance, WIA_DPS_DOCUMENT_HANDLING_SELECT, WIA_IPA_TYMED, etc).
Note: |
Through our testing we have found the following limitation related to the Microsoft WIA toolkit: On some drivers, while using WIA 2.0, if you want to change the Image Data Type property (WIA_IPA_DATATYPE) to a custom setting then you have to set the WIA_IPS_CUR_INTENT property value to WIA_INTENT_NONE. |
Required DLLs and Libraries
LTWIA For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Platforms
LEADTOOLS WIA supports both 32-bit and 64-bit image acquisition for both WIA 1.0 (XP and earlier) and WIA 2.0 (VISTA and later). See Also
Functions: |
L_WiaSetPropertyGUID, L_WiaSetPropertyString, L_WiaSetPropertyBuffer, L_WiaSetPropertySystemTime, L_WiaGetRootItem, L_WiaEnumChildItems, L_WiaInitSession, L_WiaEndSession. |
Topics: |
|
|
For an example, refer to L_WiaGetPropertyLong.