References ▼
#include "ltwia.h"
L_LTWIA_API L_INT EXT_FUNCTION L_WiaSetPropertyString(hSession, pItem, pszID, uID, pszValue)
HWIASESSION hSession; |
handle to an existing WIA session |
L_VOID* pItem; |
pointer to IWiaItem or IWiaItem2 interface |
L_TCHAR* pszID; |
pointer to string array that represents the equivalent property ID string |
L_UINT32 uID; |
property ID |
L_TCHAR* pszValue; |
pointer to a string buffer to set |
Sets a string value for any WIA property of type VT_BSTR that is not Read only.
| 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 having the property. | |
| 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. | ||
| 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 this parameter is NULL then the WIA toolkit will use the ID passed through the uID parameter, otherwise the pszID parameter will be used whether or not you passed valid property ID through the uID parameter. | ||
| uID | The property ID of the property. | |
| This parameter is required only if the pszID parameter is NULL, otherwise you can pass 0 for this parameter. | ||
| pszValue | Pointer to allocated string buffer to be used to set the value of the provided items property ID. | |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
This feature is available in version 16 or higher.
You can set the string you want for any WIA property of type VT_BSTR that is not Read only.
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.
Functions: |
L_WiaSetPropertyLong, L_WiaSetPropertyBuffer, L_WiaSetPropertyGUID, L_WiaSetPropertySystemTime, L_WiaGetRootItem, L_WiaEnumChildItems, L_WiaInitSession, L_WiaEndSession. |
Topics: |
|
|
For an example, refer to L_WiaGetPropertyString.