LWia::SetPropertyBuffer

Summary

Sets the filled buffer array for any type VT_UI1 | VT_VECTOR properties.

Syntax

#include "ltwrappr.h"

virtual L_INT LWia::SetPropertyBuffer(pItem, pszID, uID, pValue, uSize)

Parameters

L_VOID * pItem

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

Retrieve pItem 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

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 pszID is NULL, the WIA toolkit uses the ID passed through the uID parameter; otherwise, the pszID parameter is used regardless of whether a valid property ID has been passed 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; otherwise, you can pass 0 for this parameter.

L_UCHAR * pValue

Pointer to the buffer to be set for the property provided through the Property ID parameter.

L_SIZE_T uSize

Variable containing the allocated buffer size.

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.

Any WIA property of type VT_UI1 | VT_VECTOR that is not Read only can be set by calling [LWia:SetPropertyBuffer.

Required DLLs and Libraries

See Also

Functions

Topics

Example

Since there is no Read/Write buffer property of type VT_UI1 | VT_VECTOR until now, then we can't provide
a sample for the SetPropertyBuffer function.

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

LEADTOOLS WIA C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.