Skip to content

captured-result.md

Latest commit

 

History

History
300 lines (180 loc) · 7.75 KB

captured-result.md

File metadata and controls

300 lines (180 loc) · 7.75 KB
Raw
layout default-layout
title class CCapturedResult - Dynamsoft Capture Vision C++ Edition API Reference
description This page shows the C++ edition of the class CCapturedResult in Dynamsoft Capture Vision Router Module.
keywords captured result, c++
needAutoGenerateSidebar true

CCapturedResult

The CCapturedResult class represents the result of a capture operation on an image. Internally, CaptureResult stores an array that contains multiple items, each of which may be a barcode, text line, detected quad, normalized image, raw image, parsed item, etc.

Definition

Namespace: dynamsoft::cvr

Assembly: DynamsoftCaptureVisionRouter

class CCapturedResult

Methods

Method Description
GetOriginalImageHashId Gets the hash ID of the original image.
GetOriginalImageTag Gets the tag of the original image.
GetItemsCount Gets the number of items in the captured result.
GetItem Gets a specific item in the captured result.
HasItem Check if the item is present in the array.
RemoveItem Remove a specific item from the array in the captured result.
GetRotationTransformMatrix Get the rotation transformation matrix of the original image relative to the rotated image.
GetErrorCode Gets the error code of the capture operation.
GetErrorString Gets the error message of the capture operation.
operator[] Gets a pointer to the [CCapturedResultItem]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html) object at the specified index.
Retain Increases the reference count of the CCapturedResult object.
Release Decreases the reference count of the CCapturedResult object.
GetDecodedBarcodesResult Gets the decoded barcode items from the CCapturedResult.
GetRecognizedTextLinesResult Gets the recognized text line items from the CCapturedResult.
GetProcessedDocumentResult Gets the processed document items from the CCapturedResult.
GetParsedResult Gets the parsed result items from the CCapturedResult.
AddItem Add a specific item to the array in the CCapturedResult.

GetOriginalImageHashId

Gets the hash ID of the original image.

const char* GetOriginalImageHashId() const

Return value

Returns the hash ID of the original image as a null-terminated string. You are not required to release the memory pointed to by the returned pointer.

GetOriginalImageTag

Gets the tag of the original image.

const CImageTag* GetOriginalImageTag() const

Return value

Returns a pointer to the CImageTag object containing the tag of the original image. You are not required to release the memory pointed to by the returned pointer.

See Also

[CImageTag]({{ site.dcvb_cpp_api }}core/basic-structures/image-tag.html)

GetItemsCount

Gets the number of items in the captured result.

int GetItemsCount() const

Return value

Returns the number of items in the captured result.

GetItem

Gets a specific item in the captured result.

const CCapturedResultItem* GetItem(int index) const

Parameters

[in] index The index of the item to retrieve.

Return value

Returns a pointer to the [CCapturedResultItem]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html) object at the specified index.

See Also

[CCapturedResultItem]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html)

HasItem

Check if the item is present in the array.

bool HasItem(const CCapturedResultItem* item) const

Parameters

[in] item The specific item to check.

Return value

Returns a bool value indicating whether the item is present in the array or not.

See Also

[CCapturedResultItem]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html)

RemoveItem

Remove a specific item from the array in the captured result.

int RemoveItem(const CCapturedResultItem* item)

Parameters

[in] item The specific item to remove.

Return value

Return value indicating whether the deletion was successful or not.

See Also

[CCapturedResultItem]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html)

GetRotationTransformMatrix

Get the rotation transformation matrix of the original image relative to the rotated image.

void GetRotationTransformMatrix(double matrix[9]) const;

Parameters

[out] matrix A double array which represents the rotation transform matrix.

GetErrorCode

Gets the error code of the capture operation.

int GetErrorCode() const

Return value

Returns the error code of the capture operation.

See Also

[ErrorCode]({{ site.dcvb_cpp_api }}core/enum-error-code.html?src=cpp&&lang=cpp)

GetErrorString

Gets the error message of the capture operation.

const char* GetErrorString() const

Return value

Returns the error message of the capture operation as a null-terminated string. You are not required to release the memory pointed to by the returned pointer.

operator[]

Gets a pointer to the [CCapturedResultItem]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-item.html) object at the specified index.

virtual const CCapturedResultItem* operator[](int index) const = 0;

Parameters

[in] index The index of the item to retrieve.

Return value

Returns a pointer to the CCapturedResultItem object at the specified index.

Retain

Increases the reference count of the CCapturedResult object.

virtual CCapturedResult* Retain() = 0;

Return value

Return an object of CCapturedResult.

Release

Decreases the reference count of the CCapturedResult object.

virtual void Release() = 0;

GetDecodedBarcodesResult

Gets the decoded barcode items from the CCapturedResult.

dbr::CDecodedBarcodesResult* GetDecodedBarcodesResult() const

Return value

Returns a pointer to the CDecodedBarcodesResult object containing the decoded barcode items.

Remarks

Do not forget to release the memory pointed to by the returned pointer.

GetRecognizedTextLinesResult

Gets the recognized text line items from the CCapturedResult.

dlr::CRecognizedTextLinesResult* GetRecognizedTextLinesResult() const

Return value

Returns a pointer to the CRecognizedTextLinesResult object containing the recognized text line items.

Remarks

Do not forget to release the memory pointed to by the returned pointer.

GetProcessedDocumentResult

Gets the processed document items from the CCapturedResult.

ddn::CProcessedDocumentResult* GetProcessedDocumentResult() const

Return value

Returns a pointer to the CProcessedDocumentResult object containing the processed document items.

Remarks

Do not forget to release the memory pointed to by the returned pointer.

GetParsedResult

Gets the parsed result items from the CCapturedResult.

dpr::CParsedResult* GetParsedResult() const

Return value

Returns a pointer to the CParsedResult object containing the parsed result items.

Remarks

Do not forget to release the memory pointed to by the returned pointer.

AddItem

Add a specific item to the array in the captured result.

int AddItem(const CCapturedResultItem* item)

Parameters

[in] item The specific item to add.

Return value

Returns value indicating whether the addition was successful or not.