Microsoft Information Protection (MIP) SDK for C: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C
Loading...
Searching...
No Matches
protect_by_template_action_cc.h File Reference

Contains C API definitions for "protect by template" label policy action. More...

+ Include dependency graph for protect_by_template_action_cc.h:

Go to the source code of this file.

Functions

 MIP_CC_API (mip_cc_result) MIP_CC_ProtectByTemplateAction_GetTemplateId(const mip_cc_action action
 Gets a "protect by template" action's template ID.
 

Variables

char const int64_t int64_t * actualUrlSize
 
mip_cc_guid mip_cc_errorerrorInfo
 
bool * isDoubleKey
 
mip_cc_guidtemplateId
 
char * urlBuffer
 
char const int64_t urlBufferSize
 
int64_t * urlSize
 

Detailed Description

Contains C API definitions for "protect by template" label policy action.

Definition in file protect_by_template_action_cc.h.

Function Documentation

◆ MIP_CC_API()

MIP_CC_API ( mip_cc_result ) const

Gets a "protect by template" action's template ID.

Gets double key encryption url.

Gets size of buffer required to store the double key encryption url.

Gets a "protect by template" action's whether or not it is double key.

Parameters
action"protect by template" action
templateId[Output] ID of template that defines protections
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
action"protect by template" action
isDoubleKey[Output] Whether or not this is a double key template
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
action"protect by template" action
urlSize[Output] Size of buffer to hold the url (in number of chars)
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
action"protect by template" action
urlBuffer[Output] Buffer the url will be copied into.
urlBufferSizeSize (in number of chars) of the urlBuffer.
actualUrlSize[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 urlBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualUrlSize will be set to the minimum required buffer size.
  • If the template action is not double key then MIP_RESULT_ERROR_NOT_SUPPORTED_OPERATION will be returned

Variable Documentation

◆ actualUrlSize

char const int64_t int64_t* actualUrlSize

Definition at line 100 of file protect_by_template_action_cc.h.

◆ errorInfo

char const int64_t int64_t mip_cc_error* errorInfo

Definition at line 51 of file protect_by_template_action_cc.h.

◆ isDoubleKey

bool* isDoubleKey

Definition at line 64 of file protect_by_template_action_cc.h.

◆ templateId

mip_cc_guid* templateId

Definition at line 50 of file protect_by_template_action_cc.h.

◆ urlBuffer

char* urlBuffer

Definition at line 98 of file protect_by_template_action_cc.h.

◆ urlBufferSize

char const int64_t urlBufferSize

Definition at line 99 of file protect_by_template_action_cc.h.

◆ urlSize

int64_t* urlSize

Definition at line 78 of file protect_by_template_action_cc.h.