←Select platform

GetPropertySystemTime Method

Summary

Retrieves a System.DateTime structure for any WIA property of type WiaVariableTypes.UI2 or WiaVariableTypes.Vector.

Syntax

C++

public DateTime GetPropertySystemTime(  
   object item, 
   string propertyIdName, 
   Leadtools.Wia.WiaPropertyId propertyId 
)

Public Function GetPropertySystemTime( _ 
   ByVal item As Object, _ 
   ByVal propertyIdName As String, _ 
   ByVal propertyId As Leadtools.Wia.WiaPropertyId _ 
) As Date

public: 
DateTime GetPropertySystemTime(  
   Object^ item, 
   String^ propertyIdName, 
   Leadtools.Wia.WiaPropertyId 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 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*; otherwise this parameters will be used whether or not you passed valid property ID through the propertyId parameter

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

Return Value

The WIA system date.

Remarks

Call this function to retrieve a System.DateTime structure for any WIA property of type /// WiaVariableTypes.UI2 or WiaVariableTypes.Vector (for instance, and WiaPropertyId.DeviceTime WiaPropertyId.ItemTime) to return the date and time of the item.

For more information, refer to Managing WIA Sources.

Example

                                                                                              
id="CSharpExampleTab" onclick="$.selectCodeContainer(this)">C#
 id="VBExampleTab" onclick="$.selectCodeContainer(this)">VB

 codeContainer VBExample hide">Imports Leadtools  Imports Leadtools.Codecs  Imports Leadtools.Wia   Dim wia_Session As WiaSession  <TestMethod()> _  style="color:Blue;">#If Not LEADTOOLS_V19_OR_LATER Then  Public Sub GetPropertySystemTimeExample(ByVal parent As IWin32Window)  style="color:Blue;">#Else  Public Sub GetPropertySystemTimeExample(ByVal parent As IntPtr)  style="color:Blue;">#End If ' #If LEADTOOLS_V19_OR_LATER Then  If (Not WiaSession.IsAvailable(WiaVersion.Version1)) Then  MessageBox.Show("WIA version 1.0 not installed.")  Return  End If  wia_Session = New WiaSession()  wia_Session.Startup(WiaVersion.Version1)   Dim res As DialogResult = wia_Session.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault)  If res <> DialogResult.OK Then  MessageBox.Show("Error selecting WIA device.")  wia_Session.Shutdown()  Return  End If   Dim rootItem As Object = wia_Session.GetRootItem(Nothing)  If Not rootItem Is Nothing Then  AddHandler wia_Session.EnumItemsEvent, AddressOf session_EnumItemsEvent5   wia_Session.EnumChildItems(rootItem)   RemoveHandler wia_Session.EnumItemsEvent, AddressOf session_EnumItemsEvent5  End If   wia_Session.Shutdown()  End Sub   Private Sub session_EnumItemsEvent5(ByVal sender As Object, ByVal e As WiaEnumItemsEventArgs)  If Not e.Item Is Nothing Then  ' Get the item's system time.  Dim dateTimeValue As DateTime = wia_Session.GetPropertySystemTime(e.Item, Nothing, WiaPropertyId.ItemTime)   ' You can change the item's system time to your machine system time.  dateTimeValue = System.DateTime.Now  wia_Session.SetPropertySystemTime(e.Item, Nothing, WiaPropertyId.ItemTime, dateTimeValue)   wia_Session.FreeItem(e.Item)  End If  End Sub

codeContainer CSharpExample hide">

using Leadtools;  using Leadtools.Codecs;  using Leadtools.Wia;   WiaSession wia_Session;  [TestMethod]  style="color:Blue;">#if !LEADTOOLS_V19_OR_LATER  public void GetPropertySystemTimeExample(IWin32Window parent)  style="color:Blue;">#else  public void GetPropertySystemTimeExample(IntPtr parent)  style="color:Blue;">#endif // #if !LEADTOOLS_V19_OR_LATER  {  if (!WiaSession.IsAvailable(WiaVersion.Version1))  {  MessageBox.Show("WIA version 1.0 not installed.");  return;  }  wia_Session = new WiaSession();  wia_Session.Startup(WiaVersion.Version1);   DialogResult res = wia_Session.SelectDeviceDlg(parent, WiaDeviceType.Default, WiaSelectSourceFlags.NoDefault);  if (res != DialogResult.OK)  {  MessageBox.Show("Error selecting WIA device.");  wia_Session.Shutdown();  return;  }   object rootItem = wia_Session.GetRootItem(null);  if (rootItem != null)  {  wia_Session.EnumItemsEvent += new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent5);   wia_Session.EnumChildItems(rootItem);   wia_Session.EnumItemsEvent -= new EventHandler<WiaEnumItemsEventArgs>(wiaSession_EnumItemsEvent5);  }   wia_Session.Shutdown();  }   void wiaSession_EnumItemsEvent5(object sender, WiaEnumItemsEventArgs e)  {  if (e.Item != null)  {  // Get the item's system time.  DateTime dateTimeValue = wia_Session.GetPropertySystemTime(e.Item, null, WiaPropertyId.ItemTime);   // You can change the item's system time to your machine system time.  dateTimeValue = System.DateTime.Now;  wia_Session.SetPropertySystemTime(e.Item, null, WiaPropertyId.ItemTime, dateTimeValue);   wia_Session.FreeItem(e.Item);  }  }