←Select platform

GetPropertyLong Method

Syntax
C#
C++/CLI
Python
public int GetPropertyLong( 
   object item, 
   string propertyIdName, 
   WiaPropertyId propertyId 
) 
public: 
int GetPropertyLong(  
   Object^ item, 
   String^ propertyIdName, 
   WiaPropertyId propertyId 
)  
def GetPropertyLong(self,item,propertyIdName,propertyId): 

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 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 parameter will be used whether or not you passed a valid property ID through the propertyId parameter

propertyId
The property ID for the value being sought. For a list of available property IDs, refer to WiaPropertyId.

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

Return Value

The WIA long value.

Remarks

Call this function to retrieve the Long value for any WIA property of the types mentioned (for instance, WiaPropertyId.ScannerDeviceDocumentHandlingSelect , WiaPropertyId.DeviceInfoDevTypewiapropertyid.itembuffersize, etc.)

For more information, refer to Managing WIA Sources.

Example
C#
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Wia; 
 
 
WiaSession myWia_Session; 
 
public void GetPropertyLongExample(IntPtr parent) 
{ 
   if (!WiaSession.IsAvailable(WiaVersion.Version2)) 
   { 
      Console.WriteLine("WIA version 2.0 not installed."); 
      return; 
   } 
 
   myWia_Session = new WiaSession(); 
   myWia_Session.Startup(WiaVersion.Version2); 
 
   DialogResult res = myWia_Session.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault); 
   if (res != DialogResult.OK) 
   { 
      Console.WriteLine("Error selecting WIA device."); 
      myWia_Session.Shutdown(); 
      return; 
   } 
 
   object rootItem = myWia_Session.GetRootItem(null); 
   if (rootItem != null) 
   { 
      myWia_Session.EnumItemsEvent += new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent4); 
 
      myWia_Session.EnumChildItems(rootItem); 
 
      myWia_Session.EnumItemsEvent -= new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent4); 
   } 
 
   myWia_Session.Shutdown(); 
} 
 
void wiaSession_EnumItemsEvent4(object sender, WiaEnumItemsEventArgs e) 
{ 
   if (e.Item != null) 
   { 
      // Read the document handling select property. 
      int longValue = myWia_Session.GetPropertyLong(e.Item, null, WiaPropertyId.ScannerDeviceDocumentHandlingSelect); 
 
      // If the Feeder is not selected then select the Feeder. 
      if ((longValue & (int)WiaScanningModeFlags.Duplex) != (int)WiaScanningModeFlags.Duplex) 
      { 
         longValue = (int)WiaScanningModeFlags.Duplex; 
         myWia_Session.SetPropertyLong(e.Item, null, WiaPropertyId.ScannerDeviceDocumentHandlingSelect, longValue); 
      } 
 
      myWia_Session.FreeItem(e.Item); 
   } 
} 
Requirements

Target Platforms

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

Leadtools.Wia Assembly

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