Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
MetadataEntry Class Reference

An abstraction class for metadata entry. More...

#include <src/api/mip/upe/metadata_entry.h>

Public Member Functions

const std::string & GetKey () const
 Get the metadata entry key.
 
const std::string & GetValue () const
 Get the metadata entry value.
 
MetadataVersion GetVersion () const
 Get the metadata entry version.
 
 MetadataEntry (const std::string &key, const std::string &value)
 C'tor for a MetadataEntry abstraction, version is set to a default of 0.
 
 MetadataEntry (const std::string &key, const std::string &value, const MetadataVersion &version)
 C'tor for a MetadataEntry abstraction.
 
 MetadataEntry (const std::string &key, const std::string &value, uint32_t version)
 C'tor for a MetadataEntry abstraction.
 

Detailed Description

An abstraction class for metadata entry.

Definition at line 47 of file metadata_entry.h.

Constructor & Destructor Documentation

◆ MetadataEntry() [1/3]

MetadataEntry::MetadataEntry ( const std::string & key,
const std::string & value,
uint32_t version )
inline

C'tor for a MetadataEntry abstraction.

Parameters
keymetadata key entry.
valuemetadata value entry
versionmetadata version value

Definition at line 56 of file metadata_entry.h.

58 }
MetadataEntry(const std::string &key, const std::string &value, uint32_t version)
C'tor for a MetadataEntry abstraction.
Interface for a MetadataVersion.

◆ MetadataEntry() [2/3]

MetadataEntry::MetadataEntry ( const std::string & key,
const std::string & value,
const MetadataVersion & version )
inline

C'tor for a MetadataEntry abstraction.

Parameters
keymetadata key entry.
valuemetadata value entry
versionmetadata version value

Definition at line 66 of file metadata_entry.h.

67 : mKey(key),
68 mValue(value),
69 mVersion(version){
70 }

◆ MetadataEntry() [3/3]

MetadataEntry::MetadataEntry ( const std::string & key,
const std::string & value )
inline

C'tor for a MetadataEntry abstraction, version is set to a default of 0.

Parameters
keymetadata key entry.
valuemetadata value entry

Definition at line 77 of file metadata_entry.h.

78 : MetadataEntry(key, value, 0) {
79 }

Member Function Documentation

◆ GetKey()

const std::string & MetadataEntry::GetKey ( ) const
inline

Get the metadata entry key.

Returns
metadata entry key.

Definition at line 85 of file metadata_entry.h.

85{ return mKey; }

◆ GetValue()

const std::string & MetadataEntry::GetValue ( ) const
inline

Get the metadata entry value.

Returns
metadata entry value.

Definition at line 91 of file metadata_entry.h.

91{ return mValue; }

◆ GetVersion()

MetadataVersion MetadataEntry::GetVersion ( ) const
inline

Get the metadata entry version.

Returns
metadata entry version.

Definition at line 97 of file metadata_entry.h.

97{ return mVersion; }

The documentation for this class was generated from the following file: