LWia::GetProperties

Summary

Gets the properties for the specified item.

Syntax

#include "ltwrappr.h"

virtual L_INT LWia::GetProperties(pItem, pProperties)

Parameters

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 LWia::GetRootItem function to get a pointer to the device's root item or by enumerating the child items of the device through a call to LWia::EnumChildItems.

pLWIAPROPERTIES pProperties

Pointer to a structure of type LWIAPROPERTIES to receive the item's properties.

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 fills 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.

See Also

Functions

• LWia::EnumChildItems
• LWia::GetRootItem
• LWia::EnumItemsCallBack
• LWia::EnumDevices
• LWia::InitSession
• LWia::EndSession
• Class Members

Topics

• Managing WIA Sources
• WIA Functionality: Property Functions
• WIA Functionality: Callbacks

Example

For an example, refer to LWia::GetRootItem.