Welcome to the reference documentation for the Microsoft Information Protection SDK for C++.

For tutorials, getting started guides, and conceptual documentation, visit the Microsoft Learn MIP developer documentation.

Classes

Class	Description
`xml`
`XmlDelegate`	Interface for overriding XML handling (must be capable of handling multiple threads)
`XmlDocument`
`XmlLoadException`
`XmlNamespace`
`XmlNode`
`XmlParserException`
`XmlReader`	XmlReader abstraction class
`AccessDeniedError`	The user could not get access to the content. For example, no permissions, content revoked
`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)
`ActionData`
`AddContentFooterAction`	An action class that specifies adding a content footer to the document
`AddContentHeaderAction`	An action class that specifies adding content header
`AddDynamicWatermarkAction`	An action class that specifies adding watermark
`AddDynamicWatermarkActionData`
`AddWatermarkAction`	An action class that specifies adding watermark
`AddWatermarkActionData`
`AdhocProtectionRequiredError`	Adhoc protection should be set to complete the action on the file
`ApplicationActionState`
`ApplicationInfo`	A struct that includes application specific information
`ApplyLabelAction`	Apply label actions requires the calling application to apply a specific label
`ArgumentData`
`AsyncControl`	Class used to cancel async operation
`AuditDelegate`	A class that defines the interface to the MIP SDK audit notifications
`AuditEvent`	A single audit event
`AuthDelegate`	Delegate for auth related operations
`OAuth2Challenge`	Class that contains all the information required from the calling application in order to generate an oauth2 token
`OAuth2Token`	A class containing access token info provided by an application
`BadInputError`	Bad input error, thrown when the input to an SDK API is invalid
`ClassificationData`
`ClassificationRequest`	Class that contains the request of a classification call on the Execution State
`ClassificationResult`	Class that contains the result of a classification call on the Execution State
`ComputeEngine`
`Settings`
`ComputeEngineContext`
`ConditionData`
`ConsentDelegate`	Delegate for consent related operations
`ConsentDeniedError`	An operation that required consent from user was not granted consent
`ContentFormatNotSupportedError`	Content Format is not supported
`ContentLabel`	Abstraction for a Microsoft Information Protection label that is applied to a piece of content, typically a document
`ContentMarkingActionData`
`CustomAction`	CustomAction is a generic action class that captures all the sub-properties of the action as a property bag. The caller is responsible to understand the meaning of the action
`CustomerKeyUnavailableError`	Bring your own encryption key needed and unavailable
`DelegateResponseError`	Delegate Response Error. Thrown or returned in response to encountering an error in a delegate method
`DelegationLicense`
`DelegationLicenseSettings`
`DeprecatedApiError`	Caller invoked a deprecated API
`DetailedClassificationResult`	Class that contains the result of a classification call on the Execution State
`DiagnosticConfiguration`	Custom diagnostic configurations (not commonly used)
`DiagnosticDelegate`	A class that defines the interface to the MIP SDK audit/telemetry notifications
`DirectoryObject`	The directory object information which includes- type, email, objectId and PUID
`DirectoryObjectRights`	The directory object and rights associated with it
`DocumentState`
`DynamicWatermark`	Representation of the dynamic watermark which the admin has configured for a label
`EditableStream`
`Error`	Base class for all errors that will be reported (thrown or returned) from MIP SDK
`Event`	A single audit/telemetry event
`EventContext`	A single audit/telemetry event context
`EventProperty`	A single audit/telemetry property
`ExecutionState`	Interface for all the state needed to execute the engine
`ExtendedErrorInfo`
`FileExecutionState`
`FileHandler`	Interface for all file handling functions
`Observer`	Observer interface for clients to get notifications events related to file handler
`FileInspector`
`FileIOError`	File IO error
`FileProfile`	FileProfile class is the root class for using the Microsoft Information Protection operations
`Observer`	Observer interface for clients to get notifications for profile related events
`Settings`	Settings used by FileProfile during its creation and throughout its lifetime
`FileStatus`	Interface for all file status functions
`GetTemplatesSettings`	Settings to use when obtaining templates
`HttpDelegate`	Interface for overriding HTTP handling
`HttpOperation`	Interface that describes a single HTTP operation, implemented by client app when overriding HttpDelegate
`HttpRequest`	Interface that describes a single HTTP request
`HttpResponse`	Interface that describes a single HTTP response, implemented by client app when overriding HttpDelegate
`Identity`	Abstraction for identity
`InsufficientBufferError`	Insufficient buffer error
`InternalError`	Internal error. This error is thrown when something unexpected happens during execution
`JsonDelegate`
`JsonDocument`	JsonDocument abstraction class
`JsonValue`
`JustificationRequiredError`
`JustifyAction`	Justify Action requires providing a justification to a label downgrade and setting the response in the execution state
`Label`	Abstraction for a single Microsoft Information Protection label
`LabelActionData`
`LabelDisabledError`	Label is disabled or inactive
`LabelGroupData`
`LabelInfo`	Label information for a template or ad-hoc (custom) protection
`LabelingOptions`	Interface for configuring labeling options for the SetLabel/DeleteLabel methods
`LabelNotFoundError`	Label ID is not recognized
`LicenseApplicationData`	The application data from a license
`LicenseConnectionInfo`	The connection information from a license
`LicenseDescriptor`	The descriptor from a license
`LicenseInfo`	Representation of the dynamic watermark which the admin has configured for a label
`LicenseNameAndDescriptionItem`	The descriptor line item from a license
`LicenseNotRegisteredError`	License is not registered
`LicenseRightsData`	The rights related information of the publishing license
`LoggerConfiguration`	Configuration to use when default logging is enabled. This is set only once per process and any later change will be ignored
`LoggerDelegate`	A class that defines the interface to the MIP SDK logger
`LogMessageData`	A class that stores log messages
`MetadataAction`	An Action that adds metadata information to the content
`MetadataEntry`	An abstraction class for metadata entry
`MetadataVersion`	Interface for a MetadataVersion. MetadataVersion determines which metadata is active and how it is processed
`MipConfiguration`	Configuration used by MIP sdk during its creation and throughout its lifetime
`MipContext`	MipContext represents state that is shared across all profiles, engines, handlers
`MsgAttachmentData`
`MsgInspector`
`NetworkError`	Networking error. Caused by unexpected behavior when making network calls to service endpoints
`NoAuthTokenError`	The user could not get access to the content due to missing authentication token
`NoPermissionsError`	The user could not get access to the content. For example, no permissions, content revoked
`NoPermissionsExtendedError`	The user could not get access to the content due to extended Access checks like ABAC
`NoPolicyError`	Tenant policy is not configured for classification/labels
`NotSupportedError`	The operation requested by the application is not supported by the SDK
`OperationCancelledError`	Operation was cancelled
`ParsedPublishingLicense`
`ParsedPublishingLicenseBuilder`
`PolicyHandler`	This class provides an interface for all policy handler functions on a file
`PolicyPackageData`
`PolicyRuleData`
`PrivilegedRequiredError`	Current label was assigned as a privileged operation (The equivalent to an administrator operation), therefore it can't be overriden
`PropertyData`
`ProtectAdhocAction`	An action class that specifies adding adhoc protection to the document
`ProtectAdhocDkAction`	An action class that specifies adding adhoc double key protection to the document
`ProtectByEncryptOnlyAction`	An action class that specifies adding encrypt only protection to the document
`ProtectByTemplateAction`	An action class that specifies adding protection by template to the document
`ProtectDoNotForwardAction`	An action class that specifies adding do not forward protection to the document
`ProtectDoNotForwardDkAction`	An action class that specifies adding do not forward double key protection to the document
`ProtectionActionData`
`ProtectionCommonSettings`	Settings to use for protection operations
`ProtectionDescriptor`	Description of protection associated with a piece of content
`ProtectionDescriptorBuilder`	Constructs a ProtectionDescriptor that describes protection associated with a piece of content
`ProtectionEngine`	Manages protection-related actions related to a specific identity
`Observer`	Interface that receives notifications related to ProtectionEngine
`Settings`	Settings used by ProtectionEngine during its creation and throughout its lifetime
`ProtectionHandler`	Manages protection-related actions for a specific protection configuration
`ConsumptionSettings`	Settings used to create a ProtectionHandler to consume existing content
`Observer`	Interface that receives notifications related to ProtectionHandler
`PublishingSettings`	Settings used to create a ProtectionHandler to protect new content
`ProtectionProfile`	ProtectionProfile is the root class for performing protection operations
`Observer`	Interface that receives notifications related to ProtectionProfile
`Settings`	Settings used by ProtectionProfile during its creation and throughout its lifetime
`ProtectionSettings`	Interface for configuring protection options for the SetLabel method
`ProxyAuthenticationError`	Proxy authentication failure
`PublishingLicenseInfo`	Holds the details of a Publishing License used to create a protection handler
`PublishingUseLicenseRequest`	Request for a use license in the publishing request
`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
`RemoveContentFooterAction`	An action class that specifies removing the content footer from the document
`RemoveContentHeaderAction`	An action class that specifies removing the content header from the document
`RemoveDynamicWatermarkAction`	An action class that specifies removing the watermarking from the document
`RemoveProtectionAction`	An action class that specifies removing protection from the document
`RemoveWatermarkAction`	An action class that specifies removing the watermarking from the document
`RulePackageData`
`SensitiveTypeClassificationData`
`SensitivityConditionData`
`SensitivityTypesRulePackage`
`ServiceDisabledError`	The user could not get access to the content due to a service being disabled
`StorageDelegate`	A class that defines the interface to the MIP SDK storage for caching
`StorageSettings`	Settings used by StorageDelegate
`StorageTable`	A class that defines the interface to the MIP SDK storage table used for caching
`Stream`	A class that defines the interface between the MIP SDK and stream-based content
`SyncFileBaseData`
`SyncFilePolicyData`
`SyncFileSensitivityData`
`TaskDispatcherDelegate`	A class that defines the interface to the MIP SDK task dispatcher
`TelemetryDelegate`	A class that defines the interface to the MIP SDK telemetry notifications
`TelemetryEvent`	A single telemetry event
`TemplateArchivedError`	Template ID is archived and unavailable for protection
`TemplateDescriptor`
`TemplateNotFoundError`	Template ID is not recognized by RMS service
`TenantInformation`	Tenant information from RMS
`UniqueIdsAndContentFormats`
`UserRights`	A group of users and the rights associated with them
`UserRoles`	A group of users and the roles associated with them

Classes

Archived Versions