CParsedResult Class
class dynamsoft::dcp::CParsedResult
Method | Description |
---|---|
GetOriginalImageHashId |
Gets the hash ID of the source image. |
GetOriginalImageTag |
Gets the tag of the source image. |
GetItemsCount |
Gets the number of parsed result items in the parsed result. |
GetItem |
Gets the parsed result item at the specified index. |
GetErrorCode |
Gets the error code of the parsed result, if an error occurred. |
GetErrorString |
Gets the error message of the parsed result, if an error occurred. |
HasItem |
Check if the item is present in the array. |
RemoveItem |
Remove a specific item from the array in the parsed results. |
Release |
Decreases the reference count of the CParsedResult object. |
Retain |
Increases the reference count of the CParsedResult object. |
operator[] |
Gets a pointer to the CParsedResultItem object at the specified index. |
AddItem |
Adds a specific item to the array in the parsed result. |
GetOriginalImageHashId
Gets the hash ID of the source image.
virtual const char* GetOriginalImageHashId() const = 0;
Return value
Returns a pointer to a null-terminated string containing the hash ID of the source image.
GetOriginalImageTag
Gets the tag of the source image.
virtual const CImageTag* GetOriginalImageTag() const = 0;
Return value
Returns a pointer to a CImageTag object representing the tag of the source image.
See Also
GetItemsCount
Gets the number of parsed result items in the parsed result.
virtual int GetItemsCount() const = 0;
Return value
Returns the number of parsed result items in the parsed result.
GetItem
Gets the parsed result item at the specified index.
virtual const CParsedResultItem* GetItem(int index) const = 0;
Parameters
[in] index
The zero-based index of the text line result item to retrieve.
Return value
Returns a pointer to the CParsedResultItem
object at the specified index.
See Also
GetErrorCode
Gets the error code of the parsed result, if an error occurred.
virtual int GetErrorCode() const = 0;
Return value
Returns the error code of the parsed result, or 0 if no error occurred.
GetErrorString
Gets the error message of the parsed result, if an error occurred.
virtual const char* GetErrorString() const = 0;
Return value
Returns a pointer to a null-terminated string containing the error message of the parsed result, or a pointer to an empty string if no error occurred.
HasItem
Check if the item is present in the array.
virtual bool HasItem(const CParsedResultItem* item) const = 0;
Parameters
[in] item
The specific item to be checked.
Return value
Returns a bool value indicating whether the item is present in the array or not.
See Also
RemoveItem
Remove a specific item from the array in the parsed results.
virtual int RemoveItem(const CParsedResultItem* item) = 0;
Parameters
[in] item
The specific item to be removed.
Return value
Returns an error code. Zero indicates success.
See Also
Release
Decreases the reference count of the CParsedResult
object.
virtual void Release() = 0;
Retain
Increases the reference count of the CParsedResult
object.
virtual CParsedResult* Retain() = 0;
Return value
Returns an object of CParsedResult
.
operator[]
Gets a pointer to the CParsedResultItem
object at the specified index.
virtual const CParsedResultItem* operator[](int index) const = 0;
Parameters
[in] index
The index of the parsed result item to retrieve.
Return value
Returns a pointer to the CParsedResultItem
object at the specified index.
See Also
AddItem
Adds a specific item to the array in the parsed result.
virtual int AddItem(const CParsedResultItem* item) = 0;
Parameters
[in] item
The specific item to be added.
Return value
Returns an error code. Zero indicates success.
See Also