LEADTOOLS WIA (Leadtools.Wia assembly)

SetPropertyLong Method

Show in webframe





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.

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

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.

The WIA long value to set.
Sets the Long value for any WIA property of type: WiaVariableTypes.I1, WiaVariableTypes.UI1, WiaVariableTypes.I2, WiaVariableTypes.UI2, WiaVariableTypes.I4, WiaVariableTypes.UI4, WiaVariableTypes.Int, WiaVariableTypes.UInt, WiaVariableTypes.R4 and WiaVariableTypes.R8.
Syntax
public void SetPropertyLong( 
   object item,
   string propertyIdName,
   WiaPropertyId propertyId,
   int value
)
'Declaration
 
Public Sub SetPropertyLong( _
   ByVal item As Object, _
   ByVal propertyIdName As String, _
   ByVal propertyId As WiaPropertyId, _
   ByVal value As Integer _
) 
'Usage
 
Dim instance As WiaSession
Dim item As Object
Dim propertyIdName As String
Dim propertyId As WiaPropertyId
Dim value As Integer
 
instance.SetPropertyLong(item, propertyIdName, propertyId, value)

            

            
public:
void SetPropertyLong( 
   Object^ item,
   String^ propertyIdName,
   WiaPropertyId propertyId,
   int 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 long value to set.
Remarks

Call this function to set the Long value for any WIA property of the types mentioned (for instance, WiaPropertyId.ScannerDeviceDocumentHandlingSelect , WiaPropertyId.DeviceInfoDevTypeWiaPropertyId.ItemBufferSize , ...etc).

Note:

Through our testing we have found that on some drivers while using WIA 2.0, if you want to change the Image Data Type property ( WiaPropertyId.ItemDatatype ) to your custom setting you have to set the WiaPropertyId.ScannerItemCurIntent property value to None.

For more information, refer to Managing WIA Sources.

Example
Refer to WiaSession.GetPropertyGuid
Requirements

Target Platforms

See Also

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
SetPropertyString Method
GetPropertyGuid Method
GetPropertySystemTime Method
SetPropertySystemTime Method

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.