Skip to content

Latest commit

 

History

History
175 lines (106 loc) · 4.38 KB

captured-result-v3.0.30.md

File metadata and controls

175 lines (106 loc) · 4.38 KB
Raw
layout title description keywords needAutoGenerateSidebar
default-layout
class CCapturedResult - Dynamsoft Core Module C++ Edition API Reference
This page shows the C++ edition of the class CCapturedResult in Dynamsoft Core Module.
captured result, c++
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::basic_structures

Assembly: DynamsoftCore

class CCapturedResult

Methods Summary

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.

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.dcv_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 object at the specified index.

See Also

[CCapturedResultItem]({{ site.dcv_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.dcv_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.dcv_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.dcv_enumerations }}core/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.