GetPropertyString Method

Summary

Retrieves a string buffer for any WiaVariableTypes.Bstr property.

Syntax

C++/CLI

Python

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

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

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

Parameters

item
Handle to the item which represents 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 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 string value.

Remarks

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.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Wia; 
 
 
 
public void GetPropertyStringExample(IntPtr parent) 
{ 
   if (!WiaSession.IsAvailable(WiaVersion.Version1)) 
   { 
      Console.WriteLine("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) 
   { 
      Console.WriteLine("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(); 
}