GetPropertySystemTime Method

Summary

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

Syntax

C++/CLI

Python

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

public: 
DateTime GetPropertySystemTime(  
   Object^ item, 
   String^ propertyIdName, 
   WiaPropertyId propertyId 
)

def GetPropertySystemTime(self,item,propertyIdName,propertyId):

Parameters

item
Handle to the item having the property. 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 the 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, see 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 system date.

Remarks

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

For more information, refer to Managing WIA Sources.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Wia; 
 
 
WiaSession wia_Session; 
bool foundTimeItem = false; 
public void GetPropertySystemTimeExample(IntPtr parent) 
{ 
   if (!WiaSession.IsAvailable(WiaVersion.Version1)) 
   { 
      Console.WriteLine("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) 
   { 
      Console.WriteLine("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(foundTimeItem) 
   { 
      e.Stop = true; 
      return; 
   } 
   if (e.Item != null) 
   { 
      // Get the item's system time. 
      try 
      { 
         DateTime dateTimeValue = wia_Session.GetPropertySystemTime(e.Item, null, WiaPropertyId.ItemTime); 
         foundTimeItem = true; 
         // 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); 
      } 
      catch (Exception) 
      {  
         // item doesn't support Time property 
      } 
      try 
      { 
         wia_Session.EnumChildItems(e.Item); 
      } 
      catch (Exception) 
      { 
         // item has no children 
      } 
      wia_Session.FreeItem(e.Item); 
   } 
}