L_Doc2GetStatusExt

#include "ltdoc2.h"

L_LTDOC2_API L_INT L_Doc2GetStatusExt(hDoc, nDocId, pStatus, uStructSize)

Gets last recognition status.

Parameters

L_HDOC2 hDoc

Handle to the OCR document.

L_INT nDocId

Document ID created by calling L_Doc2CreateDocument.

pSTATUS2 pStatus

Pointer to a STATUS2 structure to be updated.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pStatus. Use sizeof(STATUS2) to calculate this value.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

✎ NOTE

Be sure to call L_Doc2Recognize / L_Doc2RecognizeExt before calling L_Doc2GetStatusExt. Otherwise, the STATUS2 structure will be empty and may throw an error.

The status information returned by L_Doc2GetStatusExt represents the accuracy and timing data of the last recognition operation.

Required DLLs and Libraries

See Also

Functions

Topics

Example

L_INT Doc2GetStatusExampleExt(L_HDOC2 hDoc, L_INT nDocId) 
{ 
   L_INT nRet; 
   STATUS2 Status; 
   L_TCHAR szBuffer[1024]; 
 
   ZeroMemory(&Status, sizeof(STATUS2)); 
   ZeroMemory(szBuffer, sizeof(szBuffer)); 
   nRet = L_Doc2GetStatusExt(hDoc, nDocId, &Status, sizeof(STATUS2)); 
   if (nRet == SUCCESS) 
   { 
      wsprintf(szBuffer, TEXT("Recognized Characters = %d\nRecognized Words = %d\nRejected Characters = %d\n"), 
               Status.nRecogChrCount, 
               Status.nRecogWordCount, 
               Status.nRejectChrCount); 
 
      MessageBox(NULL, szBuffer, TEXT("Notice!"), MB_OK); 
   } 
   else 
      return nRet; 
   return SUCCESS; 
} 
Help Version 20.0.2020.4.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - OmniPage Engine C API Help