DynamicWatermark Class Reference

Representation of the dynamic watermark which the admin has configured for a label. More...

#include <src/api/mip/dynamic_watermark.h>

Public Member Functions
virtual const std::string &	GetFormatString () const =0
	Gets the raw formatted string the admin has configured, which may include variables such as ${Consumer.PrincipalName}. This string can be populated from the label in the protection flow or it can be populated from the use license in the consumption flow.
virtual std::string	GetText () const =0
	Gets the text which will be displayed to the end user by replacing the variables in the format string.

Detailed Description

Representation of the dynamic watermark which the admin has configured for a label.

Definition at line 45 of file dynamic_watermark.h.

Member Function Documentation

GetFormatString()

virtual const std::string & DynamicWatermark::GetFormatString ( ) const

pure virtual

Gets the raw formatted string the admin has configured, which may include variables such as ${Consumer.PrincipalName}. This string can be populated from the label in the protection flow or it can be populated from the use license in the consumption flow.

Returns

The raw format string

GetText()

virtual std::string DynamicWatermark::GetText ( ) const

pure virtual

Gets the text which will be displayed to the end user by replacing the variables in the format string.

Returns

The display text an end user sees for the dynamic watermark, with the supported variables replaced

---

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

• src/api/mip/dynamic_watermark.h