ReleaseOCRResult Method (GdPictureOCR)

In This Topic

Releases an OCR result specified by its unique identifier. Each OCR result, identifiable by its unique ID, is internally attached to that GdPictureOCR object, which has executed the OCR process. By disposing of the current GdPictureOCR object you also release all attached OCR results.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function ReleaseOCRResult( _
   ByVal OCRResultID As String _
) As GdPictureStatus

public GdPictureStatus ReleaseOCRResult( 
   string OCRResultID
)

public function ReleaseOCRResult( 
    OCRResultID: String
): GdPictureStatus;

public function ReleaseOCRResult( 
   OCRResultID : String
) : GdPictureStatus;

public: GdPictureStatus ReleaseOCRResult( 
   string* OCRResultID
)

public:
GdPictureStatus ReleaseOCRResult( 
   String^ OCRResultID
)

Parameters

OCRResultID: A unique result identifier of the executed OCR process obtained by the RunOCR method.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

Please be aware, that each OCR result is internally linked to the GdPictureOCR object, that has executed the OCR process.

Example

How to release the OCR result to subsequently reuse the custom result identifier.

VB.NET
C#

Dim caption As String = "Example: ReleaseOCRResult"
Using gdpictureOCR As GdPictureOCR = New GdPictureOCR()
    'Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\GdPicture.Net 14\redist\OCR"
    If gdpictureOCR.AddLanguage(OCRLanguage.English) = GdPictureStatus.OK Then
        'Set up the image you want to process.
        Dim gdpictureImaging As GdPictureImaging = New GdPictureImaging()
        'The standard open file dialog displays to allow you to select the file.
        Dim image As Integer = gdpictureImaging.CreateGdPictureImageFromFile("")
        If (gdpictureImaging.GetStat() = GdPictureStatus.OK) AndAlso
           (gdpictureOCR.SetImage(image) = GdPictureStatus.OK) Then
            'Define the custom result identifier.
            Dim resID As String = "MyResult"
            'Run the first OCR process.
            'Note that gdpictureOCR.OCRMode = OCRMode.FavorSpeed by default.
            gdpictureOCR.RunOCR(resID)
            If gdpictureOCR.GetStat() = GdPictureStatus.OK Then
                'Save the result.
                If gdpictureOCR.SaveAsText(resID, "OCR_result1.txt", OCROutputTextFormat.Utf16, True) = GdPictureStatus.OK Then
                    MessageBox.Show("The OCR result has been successfully saved.", caption)
                Else
                    MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
            End If
 
            'Release the previous OCR result to make your new result identifier unique.
            'This is the only way how to reuse your custom result identifier.
            If gdpictureOCR.ReleaseOCRResult(resID) = GdPictureStatus.OK Then
                'Change OCR settings.
                gdpictureOCR.OCRMode = OCRMode.FavorAccuracy
                'Run the second OCR process.
                gdpictureOCR.RunOCR(resID)
                If gdpictureOCR.GetStat() = GdPictureStatus.OK Then
                    'Save the result.
                    If gdpictureOCR.SaveAsText(resID, "OCR_result2.txt", OCROutputTextFormat.Utf16, True) = GdPictureStatus.OK Then
                        MessageBox.Show("The OCR result has been successfully saved.", caption)
                    Else
                        MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
                    End If
                Else
                    MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
                End If
            Else
                MessageBox.Show("The ReleaseOCRResult() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
            End If
 
            'Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image)
        Else
            MessageBox.Show("The error occurred when setting up the image: " + gdpictureImaging.GetStat().ToString() + " or " + gdpictureOCR.GetStat().ToString(), caption)
        End If
        gdpictureImaging.Dispose()
    Else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
    End If
    gdpictureOCR.ReleaseOCRResults()
End Using

string caption = "Example: ReleaseOCRResult";
using (GdPictureOCR gdpictureOCR = new GdPictureOCR())
{
    //Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\\GdPicture.Net 14\\redist\\OCR";
    if (gdpictureOCR.AddLanguage(OCRLanguage.English) == GdPictureStatus.OK)
    {
        //Set up the image you want to process.
        GdPictureImaging gdpictureImaging = new GdPictureImaging();
        //The standard open file dialog displays to allow you to select the file.
        int image = gdpictureImaging.CreateGdPictureImageFromFile("");
        if ((gdpictureImaging.GetStat() == GdPictureStatus.OK) &&
            (gdpictureOCR.SetImage(image) == GdPictureStatus.OK))
        {
            //Define the custom result identifier.
            string resID = "MyResult";
 
            //Run the first OCR process.
            //Note that gdpictureOCR.OCRMode = OCRMode.FavorSpeed by default.
            gdpictureOCR.RunOCR(resID);
            if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
            {
                //Save the result.
                if (gdpictureOCR.SaveAsText(resID, "OCR_result1.txt", OCROutputTextFormat.Utf16, true) == GdPictureStatus.OK)
                    MessageBox.Show("The OCR result has been successfully saved.", caption);
                else
                    MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
            else
            {
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
 
            //Release the previous OCR result to make your new result identifier unique.
            //This is the only way how to reuse your custom result identifier.
            if (gdpictureOCR.ReleaseOCRResult(resID) == GdPictureStatus.OK)
            {
                //Change OCR settings.
                gdpictureOCR.OCRMode = OCRMode.FavorAccuracy;
 
                //Run the second OCR process.
                gdpictureOCR.RunOCR(resID);
                if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
                {
                    //Save the result.
                    if (gdpictureOCR.SaveAsText(resID, "OCR_result2.txt", OCROutputTextFormat.Utf16, true) == GdPictureStatus.OK)
                        MessageBox.Show("The OCR result has been successfully saved.", caption);
                    else
                        MessageBox.Show("The SaveAsText() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
                }
                else
                {
                    MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
                }
            }
            else
                MessageBox.Show("The ReleaseOCRResult() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            
            //Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image);
        }
        else
            MessageBox.Show("The error occurred when setting up the image: " + gdpictureImaging.GetStat().ToString() + " or " + gdpictureOCR.GetStat().ToString(), caption);
        gdpictureImaging.Dispose();
    }
    else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
    gdpictureOCR.ReleaseOCRResults();
}

Reference

GdPictureOCR Class
GdPictureOCR Members
RunOCR Method
ReleaseOCRResults Method