dynamic_watermark_cc.h File Reference

#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"

Include dependency graph for dynamic_watermark_cc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_dynamic_watermark

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_DynamicWatermark_GetFormatStringSize(const mip_cc_dynamic_watermark dynamicWatermark
	Gets size of buffer required to store format string.
	MIP_CC_API_IMPL (void) MIP_CC_ReleaseDynamicWatermark(mip_cc_dynamic_watermark dynamicWatermark)
	Function to release a dynamic watermark handle.

Variables
char const int64_t int64_t *	actualFormatStringSize
char const int64_t int64_t *	actualTextSize
int64_t mip_cc_error *	errorInfo
char *	formatStringBuffer
char const int64_t	formatStringBufferSize
int64_t *	formatStringSize
char *	textBuffer
char const int64_t	textBufferSize
int64_t *	textSize

Typedef Documentation

mip_cc_dynamic_watermark

typedef mip_cc_handle* mip_cc_dynamic_watermark

Definition at line 7 of file dynamic_watermark_cc.h.

Function Documentation

MIP_CC_API()

MIP_CC_API

(

mip_cc_result

)

const

Gets size of buffer required to store format string.

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

Gets size of buffer required to store the string returned by MIP_CC_DynamicWatermark_GetText.

Gets the raw formatted string the admin has configured, which may include variables such as ${Consumer.PrincipalName}.

Parameters

dynamicWatermark	Dynamic watermark associated with protected content
formatStringSize	[Output] Size of buffer to hold format string (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

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.

Parameters

dynamicWatermark	Dynamic watermark associated with protected content
formatStringBuffer	[Output] The raw format string configured by admin
formatStringBufferSize	Size (in number of chars) of the formatStringBuffer
actualFormatStringSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If formatStringBuffer is null or of insufficient size, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualFormatStringSize will be set to the minimum required buffer size.

Parameters

dynamicWatermark	Dynamic watermark associated with protected content
textSize	[Output] Size of buffer to hold the dynamic watermark text (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

dynamicWatermark	Dynamic watermark associated with protected content
textBuffer	[Output] the filled in text for the dynamic watermark
textBufferSize	Size (in number of chars) of the textBuffer
actualTextSize	[Output] Number of chars written to the textBuffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If textBuffer is null or of insufficient size, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualTextSize will be set to the minimum required buffer size.

MIP_CC_API_IMPL()

MIP_CC_API_IMPL

(

void

)

Function to release a dynamic watermark handle.

Parameters

dynamicWatermark

The dynamic watermark handle to release

Variable Documentation

actualFormatStringSize

char const int64_t int64_t* actualFormatStringSize

Definition at line 44 of file dynamic_watermark_cc.h.

actualTextSize

char const int64_t int64_t* actualTextSize

Definition at line 80 of file dynamic_watermark_cc.h.

errorInfo

char const int64_t int64_t mip_cc_error* errorInfo

Definition at line 21 of file dynamic_watermark_cc.h.

formatStringBuffer

char* formatStringBuffer

Definition at line 42 of file dynamic_watermark_cc.h.

formatStringBufferSize

char const int64_t formatStringBufferSize

Definition at line 43 of file dynamic_watermark_cc.h.

formatStringSize

int64_t* formatStringSize

Definition at line 20 of file dynamic_watermark_cc.h.

textBuffer

char* textBuffer

Definition at line 78 of file dynamic_watermark_cc.h.

textBufferSize

char const int64_t textBufferSize

Definition at line 79 of file dynamic_watermark_cc.h.

textSize

int64_t* textSize

Definition at line 58 of file dynamic_watermark_cc.h.