Available in LEADTOOLS Imaging Pro, Vector, Document, and Medical Imaging toolkits. |
L_WiaGetProperties
#include "ltwia.h"
L_LTWIA_API L_INT EXT_FUNCTION L_WiaGetProperties(hSession, pItem, pProperties)
HWIASESSION hSession; |
/* handle to an existing WIA session */ |
L_VOID* pItem; |
/* pointer to IWiaItem or IWiaItem2 interface */ |
pLWIAPROPERTIES pProperties; |
/* pointer to a structure */ |
Gets the properties for the specified item.
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 for which you want to get the properties. |
|
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. |
pProperties |
Pointer to a structure of type LWIAPROPERTIES to receive the items properties. |
|
You should set the uStructSize member of this structure to the sizeof(LWIAPROPERTIES) before passing it to the L_WiaGetProperties function. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This feature is available in version 16 or higher.
This function will fill the pProperties structure with the properties of the item passed through the pItem parameter.
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
Earlier and later operating systems than Windows XP for WIA Version 1.
Windows VISTA or later for WIA Version 2.
See Also
Functions: |
L_WiaSetProperties, L_WiaGetRootItem, L_WiaEnumChildItems, L_WiaInitSession, L_WiaEndSession |
Topics: |
|
|
Example
For an example, refer to L_WiaGetRootItem.