L_WiaGetProperties

Summary

Gets the properties for the specified item.

Syntax

#include "ltwia.h"

L_LTWIA_API L_INT EXT_FUNCTION L_WiaGetProperties(hSession, pItem, pProperties)

Parameters

HWIASESSION hSession

Handle to an existing WIA session. This handle is obtained by calling the L_WiaInitSession function.

L_VOID* 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.

pLWIAPROPERTIES 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

Value	Meaning
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

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_WiaSetProperties
• L_WiaGetRootItem
• L_WiaEnumChildItems
• L_WiaInitSession
• L_WiaEndSession

Topics

• Managing WIA Sources
• WIA Functionality: Property Functions

Example

For an example, refer to L_WiaGetRootItem.