GetPropertyString Method

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public string GetPropertyString( 
   object item,
   string propertyIdName,
   WiaPropertyId propertyId
)

'Declaration
 
Public Function GetPropertyString( _
   ByVal item As Object, _
   ByVal propertyIdName As String, _
   ByVal propertyId As WiaPropertyId _
) As String

'Usage
 
Dim instance As WiaSession
Dim item As Object
Dim propertyIdName As String
Dim propertyId As WiaPropertyId
Dim value As String
 
value = instance.GetPropertyString(item, propertyIdName, propertyId)

public string GetPropertyString( 
   object item,
   string propertyIdName,
   WiaPropertyId propertyId
)

 function Leadtools.Wia.WiaSession.GetPropertyString( 
   item ,
   propertyIdName ,
   propertyId 
)

public:
String^ GetPropertyString( 
   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 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.

Return Value

The WIA string value.

Call this function to retrieve the string buffer value for any WIA property of type WiaVariableTypes.Bstr (for instance, WiaPropertyId.DeviceInfoDevName , WiaPropertyId.ItemFullItemName , ...etc).

For more information, refer to Managing WIA Sources.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub GetPropertyStringExample(ByVal parent As IWin32Window)
   If (Not WiaSession.IsAvailable(WiaVersion.Version1)) Then
      MessageBox.Show("WIA version 1.0 not installed.")
      Return
   End If

   Dim session As WiaSession = New WiaSession()
   session.Startup(WiaVersion.Version1)

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

   Dim rootItem As Object = session.GetRootItem(Nothing)
   If Not rootItem Is Nothing Then
      ' if you have a digital camera device that supports the EXIF format, you 
      ' can populate the artist field in every EXIF image that it captures.
      Dim stringValue As String = session.GetPropertyString(rootItem, Nothing, WiaPropertyId.CameraDeviceArtist)
      Console.WriteLine("Old Device Artist: {0}", stringValue)

      ' You can also change the artist field if you want.
      stringValue = "I am the new artist."
      session.SetPropertyString(rootItem, Nothing, WiaPropertyId.CameraDeviceArtist, stringValue)
      stringValue = wiaSession.GetPropertyString(rootItem, Nothing, WiaPropertyId.CameraDeviceArtist)
      Console.WriteLine("New Device Artist: {0}", stringValue)
   End If

   session.Shutdown()
End Sub

public void GetPropertyStringExample(IWin32Window parent)
{
   if (!WiaSession.IsAvailable(WiaVersion.Version1))
   {
      MessageBox.Show("WIA version 1.0 not installed.");
      return;
   }

   WiaSession wiaSession = new WiaSession();
   wiaSession.Startup(WiaVersion.Version1);

   DialogResult res = wiaSession.SelectDeviceDlg(parent, WiaDeviceType.DigitalCamera, WiaSelectSourceFlags.NoDefault);
   if (res != DialogResult.OK)
   {
      MessageBox.Show("Error selecting WIA device.");
      wiaSession.Shutdown();
      return;
   }

   object rootItem = wiaSession.GetRootItem(null);
   if (rootItem != null)
   {
      // If you have a digital camera device that supports the EXIF format, you 
      // can populate the artist field in every EXIF image that it captures.
      string stringValue = wiaSession.GetPropertyString(rootItem, null, WiaPropertyId.CameraDeviceArtist);
      Console.WriteLine("Old Device Artist: {0}", stringValue);

      // You can also change the artist if you want.
      stringValue = "I am the new artist.";
      wiaSession.SetPropertyString(rootItem, null, WiaPropertyId.CameraDeviceArtist, stringValue);
      stringValue = wiaSession.GetPropertyString(rootItem, null, WiaPropertyId.CameraDeviceArtist);
      Console.WriteLine("New Device Artist: {0}", stringValue);
   }

   wiaSession.Shutdown();
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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