Leadtools.Wia Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
GetPropertyLong Method
See Also  Example
Leadtools.Wia Namespace > WiaSession Class : GetPropertyLong Method



item
Handle to the item which represents the item having the property. You can retrieve this parameter by either calling the WiaSession.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 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.

item
Handle to the item which represents the item having the property. You can retrieve this parameter by either calling the WiaSession.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 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.

Retrieves the Long value for a WIA property of any of the following types: WiaVariableTypes.I1, WiaVariableTypes.UI1, WiaVariableTypes.I2, WiaVariableTypes.UI2, WiaVariableTypes.I4, WiaVariableTypes.UI4, WiaVariableTypes.Int, WiaVariableTypes.UInt, WiaVariableTypes.R4, or WiaVariableTypes.R8.

Syntax

Visual Basic (Declaration) 
Public Sub GetPropertyLong( _
   ByVal item As Object, _
   ByVal propertyIdName As String, _
   ByVal propertyId As WiaPropertyId _
) 
Visual Basic (Usage)Copy Code
Dim instance As WiaSession
Dim item As Object
Dim propertyIdName As String
Dim propertyId As WiaPropertyId
 
instance.GetPropertyLong(item, propertyIdName, propertyId)
C# 
public void GetPropertyLong( 
   object item,
   string propertyIdName,
   WiaPropertyId propertyId
)
C++/CLI 
public:
void GetPropertyLong( 
   Object^ item,
   String^ propertyIdName,
   WiaPropertyId propertyId
) 

Parameters

item
Handle to the item which represents the item having the property. You can retrieve this parameter by either calling the WiaSession.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 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.

Example

Visual BasicCopy Code
Dim myWia_Session As WiaSession
Public Sub GetPropertyLongExample(ByVal parent As IWin32Window)
   If (Not wiaSession.IsAvailable(WiaVersion.Version1)) Then
      MessageBox.Show("WIA version 1.0 not installed.")
      Return
   End If

   myWia_Session = New WiaSession()
   myWia_Session.Startup(WiaVersion.Version1)

   Dim res As DialogResult = myWia_Session.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault)
   If res <> DialogResult.OK Then
      MessageBox.Show("Error selecting WIA device.")
      myWia_Session.Shutdown()
      Return
   End If

   myWia_Session.GetRootItem(Nothing)
   If Not myWia_Session.RootItem Is Nothing Then
      AddHandler myWia_Session.EnumItemsEvent, AddressOf session_EnumItemsEvent4

      myWia_Session.EnumChildItems(myWia_Session.RootItem)

      RemoveHandler myWia_Session.EnumItemsEvent, AddressOf session_EnumItemsEvent4
   End If

   myWia_Session.Shutdown()
End Sub

Private Sub session_EnumItemsEvent4(ByVal sender As Object, ByVal e As WiaEnumItemsEventArgs)
   If Not e.Item Is Nothing Then
      ' Read the document handling select property.
      myWia_Session.GetPropertyLong(e.Item, Nothing, WiaPropertyId.ScannerDeviceDocumentHandlingSelect)

      ' If Feeder is not selected then select the Feeder.
      If (myWia_Session.LongValue And CInt(WiaScanningModeFlags.Feeder)) <> CInt(WiaScanningModeFlags.Feeder) Then
         myWia_Session.LongValue = CInt(WiaScanningModeFlags.Feeder)
         myWia_Session.SetPropertyLong(e.Item, Nothing, WiaPropertyId.ScannerDeviceDocumentHandlingSelect)
      End If

      myWia_Session.FreeItem(e.Item)
   End If
End Sub
C#Copy Code
WiaSession myWia_Session; 
public void GetPropertyLongExample(IWin32Window parent) 

   if (!WiaSession.IsAvailable(WiaVersion.Version1)) 
   { 
      MessageBox.Show("WIA version 1.0 not installed."); 
      return; 
   } 
 
   myWia_Session = new WiaSession(); 
   myWia_Session.Startup(WiaVersion.Version1); 
 
   DialogResult res = myWia_Session.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault); 
   if (res != DialogResult.OK) 
   { 
      MessageBox.Show("Error selecting WIA device."); 
      myWia_Session.Shutdown(); 
      return; 
   } 
 
   myWia_Session.GetRootItem(null); 
   if (myWia_Session.RootItem != null) 
   { 
      myWia_Session.EnumItemsEvent += new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent4); 
 
      myWia_Session.EnumChildItems(myWia_Session.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. 
      myWia_Session.GetPropertyLong(e.Item, null, WiaPropertyId.ScannerDeviceDocumentHandlingSelect); 
 
      // If Feeder is not selected then select the Feeder. 
      if ((myWia_Session.LongValue & (int)WiaScanningModeFlags.Feeder) != (int)WiaScanningModeFlags.Feeder) 
      { 
         myWia_Session.LongValue = (int)WiaScanningModeFlags.Feeder; 
         myWia_Session.SetPropertyLong(e.Item, null, WiaPropertyId.ScannerDeviceDocumentHandlingSelect); 
      } 
 
      myWia_Session.FreeItem(e.Item); 
   } 
}

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).

After calling this method the LongValue property will become available for you to use to get the retrieved Long value.

For more information, refer to Managing WIA Sources.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows 2000, Windows XP, Windows Vista, Windows Server 2003 family, Windows Server 2008 family

See Also