L_WiaGetRootItem

#include "ltwia.h"

L_LTWIA_API L_INT EXT_FUNCTION L_WiaGetRootItem(hSession, pItem, ppWiaRootItem)

Gets the root item for the passed pItem parameter.

Returns

Comments

This feature is available in version 16 or higher.

Gets the root item for the item passed through the pItem parameter.

If pItem is NULL then the ppWiaRootItem parameter will be updated with a pointer to the device's root item (which represents the device itself).

This is the first function you need to call to get a pointer to the device's root item. Then pass that pointer to the L_WiaEnumChildItems function to enumerate all of the device's child items. Then call this function again for any child item of the enumerated items to retrieve its root item if needed.

Required DLLs and Libraries

Platforms

Earlier and later operating systems than Windows XP for WIA Version 1.

Windows VISTA or later for WIA Version 2.

See Also

Example

L_INT EXT_CALLBACK WiaSetItemPropertiesCB(HWIASESSION hSession,
                                          L_INT PropertyID,
                                          L_INT nError,
                                          L_UINT uValueType,
                                          L_VOID * pValue,
                                          L_VOID * pUserData)
{
   UNREFERENCED_PARAMETER(hSession);
   UNREFERENCED_PARAMETER(pUserData);
   UNREFERENCED_PARAMETER(uValueType);

   L_TCHAR szMsg[MAX_PATH] = TEXT("");

   if(nError != WIA_SUCCESS)
   {
      /* Display error message for the user to inform him about the failed property set */
      wsprintf(szMsg, 
               TEXT("Failed to set the property below:\n\n")
               TEXT("Property ID: %n.\n")
               TEXT("User Value: %n.\n")
               TEXT("Error Code: %n."),
               PropertyID, (*(L_INT*)pValue), nError);

      MessageBox(NULL, szMsg, TEXT("ERROR"), MB_OK|MB_ICONERROR);
   }
   return WIA_SUCCESS;
}

static L_INT CALLBACK WiaEnumItemsCB(HWIASESSION hSession,
                                     L_INT nItemsCount,
                                     L_VOID * pItem,
                                     L_VOID * pUserData)
{
   UNREFERENCED_PARAMETER(nItemsCount);
   UNREFERENCED_PARAMETER(pUserData);

   L_INT nRet;
   LWIAPROPERTIES WiaProps;

   if(pItem != NULL)
   {
      /* Get the current properties for the received item */
      nRet = L_WiaGetProperties(hSession, pItem, &WiaProps);
      if(nRet != WIA_SUCCESS)
         return nRet;

      /* Change some of the item's properties */
      WiaProps.nMaxNumOfPages = ALL_PAGES;
      WiaProps.pDataTransfer->nImageDataType = WIA_DATA_GRAYSCALE;
      WiaProps.pImageEffects->nBrightness = 250;

      /* Set back the received item properties */
      nRet = L_WiaSetProperties(hSession, pItem, &WiaProps, WiaSetItemPropertiesCB, NULL);
      if(nRet != WIA_SUCCESS)
         return nRet;

      nRet = L_WiaFreeItem(hSession, pItem);
      if(nRet != WIA_SUCCESS)
         return nRet;
   }

   return WIA_SUCCESS;
}

L_LTWIATEX_API L_INT WiaGetRootItemExample(HWIASESSION hSession, HWND hWnd)
{
   IWiaItem * pRootItem = NULL;
   L_INT nRet;

   nRet = L_WiaSelectDeviceDlg(hSession, hWnd, WiaDeviceTypeDefault, 0);
   if(nRet != WIA_SUCCESS)
      return nRet;

   /* Get a pointer to the WIA device's root items */
   nRet = L_WiaGetRootItem(hSession, NULL, (L_VOID**)&pRootItem);
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_WiaEnumChildItems(hSession, pRootItem, WiaEnumItemsCB, NULL);
   if(nRet != SUCCESS)
      return nRet;

   return SUCCESS;
}