SetPropertyString Method

public void SetPropertyString( 
   object item,
   string propertyIdName,
   WiaPropertyId propertyId,
   string value
)

'Declaration
 
Public Sub SetPropertyString( _
   ByVal item As Object, _
   ByVal propertyIdName As String, _
   ByVal propertyId As WiaPropertyId, _
   ByVal value As String _
) 

'Usage
 
Dim instance As WiaSession
Dim item As Object
Dim propertyIdName As String
Dim propertyId As WiaPropertyId
Dim value As String
 
instance.SetPropertyString(item, propertyIdName, propertyId, value)

public:
void SetPropertyString( 
   Object^ item,
   String^ propertyIdName,
   WiaPropertyId propertyId,
   String^ value
) 

Parameters

item

Handle to the item which represents the item having the property. You can retrieve this parameter by either calling the GetRootItem method to get the device's root item itself or by enumerating the child items of the device through a call to EnumChildItems method.

propertyIdName

This string should contain the equivalent property Id string for the WIA property ID. Use the see GetPropertyIdString method to get this string for the property ID.

If you passed null for this parameter then the WIA toolkit will use the property ID passed through the third parameter propertyId; otherwise this parameters will be used whether or not you passed valid property ID through the propertyId parameter

propertyId

The property ID for the value being sought, for list of available property IDs see WiaPropertyId.

This parameter is required only if the second parameter "propertyIdName"is null; otherwise you can pass 0 for this parameter.

value

The WIA string value to set.

Sets a string value for any WIA property of type WiaVariableTypes.Bstr that is not Read only.

For more information, refer to Managing WIA Sources.

Target Platforms

Reference

WiaSession Class
WiaSession Members
Startup Method
Shutdown Method
GetRootItem Method
EnumChildItems Method
GetProperties Method
SetProperties Method
GetPropertyBuffer Method
SetPropertyBuffer Method
GetPropertyLong Method
SetPropertyLong Method
GetPropertyString Method
GetPropertyGuid Method
SetPropertyGuid Method
GetPropertySystemTime Method
SetPropertySystemTime Method