Microsoft Information Protection SDK - C 1.17
API Reference Documentation for C
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
mip_context_cc.h File Reference

Defines C-Style MipContext functions. More...

Go to the source code of this file.

Classes

struct  mip_cc_feature_override
 Defines a single feature's enabled/disabled state. More...
 

Typedefs

typedef mip_cc_handlemip_cc_mip_context
 

Functions

 MIP_CC_API (mip_cc_result) MIP_CC_CreateMipContext(const mip_cc_application_info *applicationInfo
 Create a MIP context to manage state shared across all profile instances.
 
 MIP_CC_API (void) MIP_CC_ReleaseMipContext(mip_cc_mip_context mipContext)
 Release resources associated with a MIP context.
 

Variables

const char * path
 
const char const mip_cc_log_level logLevel
 
const char const mip_cc_log_level const bool isOfflineOnly
 
const char const mip_cc_log_level const bool const mip_cc_logger_delegate loggerDelegateOverride
 
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration diagnosticOverride
 
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration mip_cc_mip_contextmipContext
 
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration mip_cc_mip_context mip_cc_errorerrorInfo
 
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_overridefeatureSettings
 
const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override const int64_t featureSettingsSize
 

Detailed Description

Defines C-Style MipContext functions.

Typedef Documentation

◆ mip_cc_mip_context

Function Documentation

◆ MIP_CC_API() [1/2]

MIP_CC_API ( mip_cc_result ) const

Create a MIP context to manage state shared across all profile instances.

Parameters
applicationInfoInfo about application that is consuming the protection SDK
pathFile path under which logging, telemetry, and other protection collateral is stored
logLevelMinimum log level for .miplog
isOfflineOnlyEnable/disable network operations (not all actions supported when offline)
loggerDelegateOverride(Optional) Logger override implementation
diagnosticOverride(Optional) Overridden telemetry settings. If NULL, default settings will be used
mipContext[Output] Newly-created MIP context instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
applicationInfoInfo about application that is consuming the protection SDK
pathFile path under which logging, telemetry, and other protection collateral is stored
logLevelMinimum log level for .miplog
isOfflineOnlyEnable/disable network operations (not all actions supported when offline)
loggerDelegateOverride(Optional) Logger override implementation
diagnosticOverride(Optional) Overridden telemetry settings. If NULL, default settings will be used
featureSettings(Optional) Array of custom feature overrides
featureSettingsSizeSize of custom feature overrides (in # of overrides)
mipContext[Output] Newly-created MIP context instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure

◆ MIP_CC_API() [2/2]

MIP_CC_API ( void )

Release resources associated with a MIP context.

Parameters
mipContextMIP context to be released

Variable Documentation

◆ diagnosticOverride

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration diagnosticOverride

◆ errorInfo

◆ featureSettings

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override* featureSettings

◆ featureSettingsSize

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override const int64_t featureSettingsSize

◆ isOfflineOnly

const char const mip_cc_log_level const bool isOfflineOnly

◆ loggerDelegateOverride

const char const mip_cc_log_level const bool const mip_cc_logger_delegate loggerDelegateOverride

◆ logLevel

const char const mip_cc_log_level logLevel

◆ mipContext

const char const mip_cc_log_level const bool const mip_cc_logger_delegate const mip_cc_telemetry_configuration const mip_cc_feature_override const int64_t mip_cc_mip_context * mipContext

◆ path

const char * path