Version 1 of the interface that supports parsing by the client supplied parser of the XMP Data Model.
More...
#include <IClientDOMParser.h>
Version 1 of the interface that supports parsing by the client supplied parser of the XMP Data Model.
Provides functions to parse the XMP Data Model. Thread safety is controllable by the client.
Definition at line 24 of file IClientDOMParser.h.
◆ ~IClientDOMParser_v1()
virtual AdobeXMPCore::IClientDOMParser_v1::~IClientDOMParser_v1 |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ AreKeysCaseSensitive()
virtual bool APICALL AdobeXMPCore::IClientDOMParser_v1::AreKeysCaseSensitive |
( |
| ) |
const |
|
inlinevirtual |
Indicates whether object supports case sensitive keys or not.
- Returns
- True in case object supports case sensitive keys, false otherwise.
- Note
- Default implementation makes keys case insensitive.
Definition at line 44 of file IClientDOMParser.h.
◆ Initialize()
virtual void APICALL AdobeXMPCore::IClientDOMParser_v1::Initialize |
( |
pIConfigurable |
configurationParameters | ) |
|
|
inlinevirtual |
Initialize the default configuration parameters.
The object needs to fill the default configuration parameters supported by it.
- Parameters
-
- Note
- default implementation does not fill anything in the configuration parameters.
Definition at line 52 of file IClientDOMParser.h.
◆ Parse()
Parse the contents present in the buffer taking into account the configuration parameters.
- Parameters
-
[in] | buffer | Pointer to a constant char buffer containing serialized XMP Data Model. |
[in] | bufferLength | Number of characters in buffer. In case name is null terminated set it to #AdobeXMPCommon::npos. |
[in] | configurationParameters | An object of type #AdobeXMPCommon::IConfigurable containing all the configuration parameters requested by client to be taken care of while parsing. |
[in] | proc | A function pointer to be used by the parse operation to report back any encountered errors/warnings. |
- Returns
- A shared pointer to #INode object containing all the parsed XMP Data Model.
◆ Release()
virtual void APICALL AdobeXMPCore::IClientDOMParser_v1::Release |
( |
| ) |
const |
|
pure virtual |
Called by the library when the object is no longer required by it and client can free up the resources or memory associated with the object.
◆ Validate()
Validate the data type and value for a parameter.
- Parameters
-
- Returns
- An error code in case there is something wrong with the combination, otherwise returns \ p0-#AdobeXMPCommon::eCECNone.
- Note
- Default implementation validates all the keys + dataTypes + dataValue combinations.
Definition at line 62 of file IClientDOMParser.h.
References AdobeXMPCommon::kCECNone.
The documentation for this class was generated from the following file: