LWia::GetPropertyGUID

#include "ltwrappr.h"

virtual L_INT LWia::GetPropertyGUID(pItem, pszID, uID, pGuidValue)

L_VOID * pItem;

pointer to IWiaItem or IWiaItem2 interface

L_TCHAR * pszID;

pointer to string array that represents the equivalent property ID string

L_UINT32 uID;

property ID

GUID * pGuidValue;

pointer to a GUID structure to be updated

Retrieves the GUID structure for any WIA property of type VT_CLSID (like WIA_IPA_FORMAT).

Parameter Description
pItem Valid pointer to a type IWiaItem or IWiaItem2 object (IWiaItem if using WIA Version 1.0; IWiaItem2 if using WIA Version 2.0), which represents the item having the property.
  You can retrieve this parameter by either calling the LWia::GetRootItem function to get a pointer to the device's root item or by enumerating the child items of the device through a call to LWia::EnumChildItems.
pszID This string pointer should contain the equivalent property ID string for the WIA property ID (see example below):
  Property ID Property ID Equivalent String
  WIA_IPA_TYM WIA_IPA_TYMED_STR or "Media Type"
  WIA_IPA_DEPTH WIA_IPA_DEPTH_STR or "Bits Per Pixel"
  If this parameter is NULL then the WIA toolkit will use the ID passed through the uID parameter, otherwise the pszID parameter will be used whether or not you passed valid property ID through the uID parameter.
uID The property ID for which you are obtaining the GUID structure.
  This parameter is required only if the pszID parameter is NULL, otherwise you can pass 0 for this parameter.
pGuidValue Pointer to a variable of type GUID to be updated with the retrieved property GUID value.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This feature is available in LEADTOOLS version 16 or higher.

Call this function to retrieve the GUID structure for any WIA property of type VT_CLSID (for instance, WIA_IPA_FORMAT).

Required DLLs and Libraries

LTWIA

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LWia::GetPropertyLong, LWia::GetPropertyString, LWia::GetPropertyBuffer, LWia::GetPropertySystemTime, LWia::GetRootItem, LWia::EnumChildItems, LWia::InitSession, LWia::EndSession, Class Members

Topics:

Managing WIA Sources

 

WIA Functionality: Property Functions

Example

class CMyWIA : public LWia 
{ 
public: 
   L_INT EnumItemsCB(L_INT nItemsCount, L_VOID * pItem); 
}; 
L_INT CMyWIA::EnumItemsCB(L_INT nItemsCount, L_VOID * pItem) 
{ 
   UNREFERENCED_PARAMETER(nItemsCount); 
   L_INT nRet; 
   GUID guidFormat; 
   if(pItem != NULL) 
   { 
      /* Get the current item's transfer format */ 
      nRet = GetPropertyGUID(pItem, NULL, WIA_IPA_FORMAT, &guidFormat); 
      if(nRet != WIA_SUCCESS) 
         return nRet; 
      /* You can also change the transfer format for that item. */ 
      guidFormat = WiaImgFmt_TIFF; 
      nRet = SetPropertyGUID(pItem, NULL, WIA_IPA_FORMAT, &guidFormat); 
      if(nRet != WIA_SUCCESS) 
         return nRet; 
      nRet = FreeItem(pItem); 
      if(nRet != WIA_SUCCESS) 
         return nRet; 
   } 
   return WIA_SUCCESS; 
} 
L_INT LWIA__GetPropertyGUIDExample() 
{ 
   L_INT nRet; 
   IWiaItem * pRootItem = NULL; 
   CMyWIA MyClass; 
   nRet = MyClass.SelectDeviceDlg(WiaDeviceTypeDefault, 0); 
   if(nRet != WIA_SUCCESS) 
      return nRet; 
   nRet = MyClass.GetRootItem(NULL, (L_VOID**)&pRootItem); 
   if(nRet != WIA_SUCCESS) 
      return nRet; 
   nRet = MyClass.EnumChildItems(pRootItem); 
   if(nRet != WIA_SUCCESS) 
      return nRet; 
   return SUCCESS; 
}

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS WIA C++ Class Library Help
Introduction
Version History
Getting Started
Files To Be Included With Your Application
Quick Reference
Tutorials
Classes and Function References