Microsoft Information Protection SDK - C 1.17
API Reference Documentation for C
Loading...
Searching...
No Matches
dynamic_watermark_cc.h File Reference

Go to the source code of this file.

Typedefs

typedef mip_cc_handlemip_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 (void) MIP_CC_ReleaseDynamicWatermark(mip_cc_dynamic_watermark dynamicWatermark)
 Function to release a dynamic watermark handle.
 

Variables

int64_t * formatStringSize
 
int64_t mip_cc_errorerrorInfo
 
char * formatStringBuffer
 
char const int64_t formatStringBufferSize
 
char const int64_t int64_t * actualFormatStringSize
 
int64_t * textSize
 
char * textBuffer
 
char const int64_t textBufferSize
 
char const int64_t int64_t * actualTextSize
 

Typedef Documentation

◆ mip_cc_dynamic_watermark

Function Documentation

◆ MIP_CC_API() [1/2]

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}. 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
dynamicWatermarkDynamic 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
Parameters
dynamicWatermarkDynamic watermark associated with protected content
formatStringBuffer[Output] The raw format string configured by admin
formatStringBufferSizeSize (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
dynamicWatermarkDynamic 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
dynamicWatermarkDynamic watermark associated with protected content
textBuffer[Output] the filled in text for the dynamic watermark
textBufferSizeSize (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() [2/2]

MIP_CC_API ( void )

Function to release a dynamic watermark handle.

Parameters
dynamicWatermarkThe dynamic watermark handle to release

Variable Documentation

◆ actualFormatStringSize

char const int64_t int64_t* actualFormatStringSize

◆ actualTextSize

char const int64_t int64_t* actualTextSize

◆ errorInfo

char const int64_t int64_t mip_cc_error* errorInfo

◆ formatStringBuffer

char* formatStringBuffer

◆ formatStringBufferSize

char const int64_t formatStringBufferSize

◆ formatStringSize

int64_t* formatStringSize

◆ textBuffer

char* textBuffer

◆ textBufferSize

char const int64_t textBufferSize

◆ textSize

int64_t* textSize