Resource Base
Table of contents

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.
operator[] Gets a pointer to the CCapturedResultItem object at the specified index.
Retain Increases the reference count of the CCapturedResult object.
Release Decreases the reference count of the CCapturedResult object.

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

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

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

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

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

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 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 CCapturedResultItem* Retain() = 0;

Return value

Return an object of CCapturedResult.

Release

Decreases the reference count of the CCapturedResult object.

virtual void Release() = 0;

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version (2.2.0)
  • Version 2.x
    • Version 2.0.30
    • Version 2.0.20
    • Version 2.0.10
    • Version 2.0.0
Change +
© 2003–2024 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support