MIP SDK for C++ (Preview) Reference

The Microsoft Information Protection (MIP) SDK for C++ (Preview) allows developers to manage and apply data protection policies to data and other digital assets.

To learn more, see MIP Developer blog.

The MIP SDK for C++ includes:

Class name Description
ConsentDelegate Delegate for consent-related operations.
mip::AccessDeniedError The user could not get access to the content, such as access denied, content revoked, and so on.
mip::Action Interface for an action. Each action translates to a step that needs to be taken by the application to apply the label (as defined in the policy)
mip::AddContentFooterAction An action class that specifies a content footer to be added to the document.
mip::AddContentHeaderAction An action class that specifies adding content header.
mip::AddWatermarkAction An action class that specifies adding watermark.
mip::ApplyLabelAction Apply label actions requires the calling application to apply a specific label.
mip::BadInputError Bad input error, thrown when the input to an sdk api is invalid.
mip::ClassificationResult Class that contains the result of a classification call on the Execution State.
mip::ContentLabel Abstraction for a Microsoft Information Protection label that is applied to a piece of content, typically a document.
mip::CustomAction CustomAction is a generic action class that captures all the subproperties of the action as a property bag. The caller is responsible to understand the meaning of the action.
mip::Error Base class for all errors that will be reported (thrown or returned) from MIP SDK.
mip::ExecutionState Interface for all the state needed to execute the engine.
mip::FileEngine Interface for all engine functions.
mip::FileEngine::Settings Not yet documented.
mip::FileHandler Interface for all file handling functions.
mip::FileHandler::Observer Observer-interface for clients to get notifications for file handler related events.
mip::FileIOError File IO error.
mip::FileProfile FileProfile class is the root class for using the Microsoft Information Protection operations.
mip::FileProfile::Observer Observer-interface for clients to get notifications for profile-related events.
mip::FileProfile::Settings Settings used by FileProfile during its creation and throughout its lifetime.
mip::InternalError Internal error. This error is thrown when something unexpected happens during execution.
mip::JustificationRequiredError Not yet documented.
mip::JustifyAction Justify Action requires providing a justification to a label downgrade and setting the response in the execution state.
mip::Label Abstraction for a single Microsoft Information Protection label.
mip::LabelingOptions Interface for configuring labeling options for the SetLabel method.
mip::LoggerDelegate A class that defines the interface to the MIP SDK logger.
mip::MetadataAction An Action that adds metadata information to the content.
mip::NetworkError Networking error. Caused by unexpected behavior when making network calls to service endpoints.
mip::NotSupportedError The operation requested by the application is not supported by the sdk.
mip::PolicyEngine This class provides an interface for all engine functions.
mip::PolicyEngine::Settings An instance of this class with the appropriate parameters should be provided to initiate an engine.
mip::PrivilegedRequiredError Current label was assigned as a privileged operation (The equivalent to an administrator operation), therefore it can't be overriden.
mip::Profile Profile class is the root class for using the Microsoft Information Protection operations. A typical application will only need one Profile but it can create multiple profiles if needed.
mip::Profile::Observer Observer-interface for clients to get notifications for profile related events.
mip::Profile::Settings Settings used by Profile during its creation and throughout its lifetime.
mip::ProtectAdhocAction An action class which specifies adding adhoc protection to the document.
mip::ProtectByTemplateAction An action class which specifies adding protection by template to the document.
mip::ProtectDoNotForwardAction An action class which specifies adding do not forward protection to the document.
mip::ProtectionDescriptor Represents an ad-hoc policy associated with protected content.
mip::ProtectionDescriptorBuilder Represents an ad-hoc policy associated with protected content.
mip::ProtectionEngine Performs protection-related actions related to a specific identity.
mip::ProtectionEngine::Observer Interface that receives notifications related to ProtectionEngine.
mip::ProtectionEngine::Settings Settings used by ProtectionEngine during its creation and throughout its lifetime.
mip::ProtectionHandler Performs protection-related actions for a specific protection configuration (i.e. users, rights, roles, etc.)
mip::ProtectionHandler::Observer Interface that receives notifications related to ProtectionHandler.
mip::ProtectionProfile ProtectionProfile is the root class for performing protection operations.
mip::ProtectionProfile::Observer Interface that receives notifications related to ProtectionProfile.
mip::ProtectionProfile::Settings Settings used by ProtectionProfile during its creation and throughout its lifetime.
mip::RecommendLabelAction Recommend label actions is meant to suggest a label to the users. Suppressing this call after a user ignores the recommended label should be done through the supported actions on the execution state.
mip::RemoveContentFooterAction An action class which specifies removing the content footer from the document.
mip::RemoveContentHeaderAction An action class which specifies removing the content header from the document.
mip::RemoveProtectionAction An action class which specifies removing protection from the document.
mip::RemoveWatermarkAction An action class which specifies removing the watermarking from the document.
mip::Stream A class that defines the interface between the MIP SDK and stream-based content.
mip::UserRights Represents a group of users and the rights associated with them.
mip::UserRoles Represents a group of users and the roles associated with them.