References ▼
Sets a string value for any WIA property of type VT_BSTR that is not Read only.
#include "ltwrappr.h"
virtual L_INT LWia::SetPropertyString(pItem, pszID, uID, pszValue)
Valid pointer to a type IWiaItem (WIA Version 1.0) or IWiaItem2 (WIA Version 2.0) object, representing the item that has the property.
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 by calling LWia::EnumChildItems.
String pointer containing 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, the WIA toolkit will use the ID passed through the uID parameter; otherwise, the pszID parameter will be used regardless of whether a valid property ID is passed through the uID parameter.
The property ID of the property.
The uID parameter is required only if the pszID parameter is NULL. If the pszID parameter is not NULL, you can pass 0 for uID.
Pointer to the allocated string buffer to be used to set the value of the provided item's property ID.
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. |
| < 1 | An error occurred. Refer to Return Codes. |
This feature is available in LEADTOOLS version 16 or higher.
You can set the string you want for any WIA property of type VT_BSTR that is not Read only.
For an example, refer to LWia::GetPropertyString.