L_Doc2RemoveItemFromUserDictionary

NOTE: User words and dictionaries are no longer supported in the OCR Professional Engine.

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2RemoveItemFromUserDictionary(hDoc, pSection, pUDitem, uMask)

Removes the specified section item from the specified section in the User dictionary.

Returns

Comments

When the characters to be deleted are contained in the ANSI (1252) Code Page, the easiest way to define the pUDitem string is with a wide-character-string literal, L"characters".

When there are two pUDItems items in the pSection with the same name, but with different attributes, the uMask parameter will determine the item to be deleted.

Deleting the last User dictionary item from a section causes the section to be removed automatically from the User dictionary.

Required DLLs and Libraries

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_INT Doc2RemoveItemFromUserDictionaryExample(L_HDOC2 hDoc) 
{ 
   L_INT nRet; 
   L_CHAR * pszSectName = "cities"; 
   L_WCHAR * pwcItem = L"Peabody"; 
   nRet = L_Doc2RemoveItemFromUserDictionary(hDoc, pszSectName, pwcItem, DOC2_USER_DICT_LITERAL); 
   if (nRet == SUCCESS) 
   { 
      USERDICTIONARY2 UDict; 
      UDict.uStructSize = sizeof(USERDICTIONARY2); 
      UDict.pszFileName = MAKE_IMAGE_PATH(TEXT("USERDIC1.DIC")); 
      UDict.pszDefSection = pszSectName; 
      // save the updated dictionary into a file 
      nRet = L_Doc2SetUserDictionary(hDoc, &UDict, FALSE); 
      if(nRet != SUCCESS) 
         return nRet; 
   } 
   else 
      return nRet; 
   return SUCCESS; 
}