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

Contains C API definitions for policy profile. More...

Go to the source code of this file.

Typedefs

typedef mip_cc_handlemip_cc_policy_profile
 
typedef mip_cc_handlemip_cc_policy_profile_settings
 

Functions

 MIP_CC_API (mip_cc_result) MIP_CC_PolicyProfile_AddEngine(const mip_cc_policy_profile profile
 Add a new policy engine to the profile.
 
 MIP_CC_API (void) MIP_CC_ReleasePolicyProfile(mip_cc_policy_profile profile)
 Release resources associated with a policy profile.
 

Variables

const mip_cc_policy_engine_settings settings
 
const mip_cc_policy_engine_settings const void * context
 
const mip_cc_policy_engine_settings const void mip_cc_policy_engineengine
 
const mip_cc_policy_engine_settings const void mip_cc_policy_engine mip_cc_errorerrorInfo
 
const mip_cc_cloud cloud
 
const mip_cc_cloud const mip_cc_auth_callback authCallback
 
mip_cc_policy_profileprofile
 
const mip_cc_cache_storage_type cacheStorageType
 
const mip_cc_cache_storage_type const void * reserved
 
const char * sessionId
 
const mip_cc_http_delegate httpDelegate
 
const mip_cc_task_dispatcher_delegate taskDispatcherDelegate
 
const mip_cc_dictionary customSettings
 

Detailed Description

Contains C API definitions for policy profile.

Typedef Documentation

◆ mip_cc_policy_profile

◆ mip_cc_policy_profile_settings

Function Documentation

◆ MIP_CC_API() [1/2]

MIP_CC_API ( mip_cc_result ) const

Add a new policy engine to the profile.

Configures custom settings, used for feature gating and testing.

Override default async task dispatcher with client's own.

Override default HTTP stack with client's own.

Sets the session ID that can be used to correlate logs and telemetry.

Create a settings object used to create a policy profile.

Load a profile.

Trigger an authentication callback.

Parameters
profileParent profile under which an engine will be added
settingsPolicy engine settings
contextClient context that will be opaquely passed to HttpDelegate and AuthDelegate
engine[Output] Newly-created policy engine instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
profileProfile
cloudAzure cloud
authCallbackAuthentication callback that will be invoked
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Note
MIP will not cache or do anything else with the value returned by the auth delegate. This function is recommended for applications that aren't "logged in" until after MIP requests an auth token. It allows an application to fetch a token before MIP actually requires one.
Parameters
settingsProfile settings
profile[Output] Newly-created policy profile instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
mipContextGlobal context shared across all profiles
cacheStorageTypeStorage cache configuration
reservedReserved for backwards compatibility - set to nullptr
settings[Output] Newly-created settings instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
settingsProfile settings
sessionIdSession ID that represents the lifetime of a policy profile
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
settingsProfile settings to which HTTP delegate will be assigned
httpDelegateHTTP callback instance implemented by client application
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
settingsProfile settings to which task dispatcher delegate will be assigned
taskDispatcherDelegateTask dispatcher callback instance implemented by client application
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
settingsProfile settings
customSettingsKey/value pairs of custom settings
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 policy profile.

Release resources associated with a policy profile settings.

Parameters
profilePolicy profile to be released
settingsPolicy profile settings to be released

Variable Documentation

◆ authCallback

const mip_cc_cloud const mip_cc_auth_callback authCallback

◆ cacheStorageType

const mip_cc_cache_storage_type cacheStorageType

◆ cloud

const mip_cc_cloud cloud

◆ context

const mip_cc_policy_engine_settings const void* context

◆ customSettings

const mip_cc_dictionary customSettings

◆ engine

◆ errorInfo

const mip_cc_dictionary mip_cc_error* errorInfo

◆ httpDelegate

const mip_cc_http_delegate httpDelegate

◆ profile

◆ reserved

const mip_cc_cache_storage_type const void* reserved

◆ sessionId

const char* sessionId

◆ settings

◆ taskDispatcherDelegate

const mip_cc_task_dispatcher_delegate taskDispatcherDelegate