Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
|
The Microsoft Information Protection (MIP) SDK for C++ allows developers to manage and apply data protection policies to data and other digital assets. For guidance on how to use it, see Microsoft Information Protection SDK documentation.
The MIP SDK for C++ reference includes the following classes:
Class | Description |
---|---|
AccessDeniedError | The user could not get access to the content |
Action | Interface for an action |
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 |
AddWatermarkAction | An action class that specifies adding watermark |
AdhocProtectionRequiredError | Adhoc protection should be set to complete the action on the file |
ApplicationInfo | A struct that includes application-specific information |
ApplyLabelAction | Apply label actions require the calling application to apply a specific label |
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 |
AuthDelegate:OAuth2Challenge | Contains information required to generate an OAuth2 token |
AuthDelegate:OAuth2Token | Contains access token info provided by an application |
BadInputError | Bad input error, thrown when the input to an SDK API is invalid |
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 |
ConsentDelegate | Delegate for consent-related operations |
ConsentDeniedError | Operation requiring consent from the user was not granted consent |
ContentFormatNotSupportedError | Content format is not supported |
ContentLabel | Abstraction for a Microsoft Information Protection label applied to content |
CustomAction | CustomAction is a generic action class that captures sub-properties of the action as a property bag |
CustomerKeyUnavailableError | Bring your own encryption key needed and unavailable |
DelegateResponseError | Delegate Response Error |
DelegationLicense | |
DelegationLicenseSettings | |
DeprecatedApiError | Caller invoked a deprecated API |
DetailedClassificationResult | Class containing result of a classification call on the Execution State |
DiagnosticConfiguration | Custom diagnostic configurations (not commonly used) |
DiagnosticDelegate | Defines the interface to MIP SDK audit/telemetry notifications |
DirectoryObject | Directory object information includes type, email, objectId, and PUID |
DirectoryObjectRights | Directory object and associated rights |
DynamicWatermark | Representation of the dynamic watermark configured for a label |
Error | Base class for all errors 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 state needed to execute the engine |
ExtendedErrorInfo | |
FileExecutionState | |
FileHandler | Interface for all file handling functions |
FileHandler:Observer | Observer interface for notifications related to file handler |
FileInspector | |
FileIOError | File IO error |
FileProfile | Root class for Microsoft Information Protection operations |
FileProfile:Observer | Observer interface for profile-related events |
FileProfile:Settings | Settings used by FileProfile during creation and throughout its lifetime |
FileStatus | Interface for all file status functions |
GetTemplatesSettings | Settings for obtaining templates |
HttpDelegate | Interface for overriding HTTP handling |
HttpOperation | Interface describing a single HTTP operation |
HttpRequest | Interface describing a single HTTP request |
HttpResponse | Interface describing a single HTTP response |
Identity | Abstraction for identity |
InsufficientBufferError | Insufficient buffer error |
InternalError | Internal error |
JsonDelegate | |
JsonDocument | JsonDocument abstraction class |
JsonValue | |
JustificationRequiredError | |
JustifyAction | Justify action requires justification for label downgrade |
Label | Abstraction for a Microsoft Information Protection label |
LabelDisabledError | Label is disabled or inactive |
LabelInfo | Label information for a template or ad-hoc (custom) protection |
LabelingOptions | Interface for configuring labeling options |
LabelNotFoundError | Label ID is not recognized |
LicenseApplicationData | Application data from a license |
LicenseConnectionInfo | Connection information from a license |
LicenseDescriptor | Descriptor from a license |
LicenseInfo | Representation of the dynamic watermark configured for a label |
LicenseNameAndDescriptionItem | Descriptor line item from a license |
LicenseNotRegisteredError | License is not registered |
LicenseRightsData | Rights information of the publishing license |
LoggerConfiguration | Configuration for default logging |
LoggerDelegate | Interface to the MIP SDK logger |
LogMessageData | Stores log messages |
MetadataAction | Action that adds metadata to the content |
MetadataEntry | Abstraction class for metadata entry |
MetadataVersion | Interface for MetadataVersion |
MipConfiguration | Configuration used by MIP SDK throughout its lifetime |
MipContext | Represents shared state across all profiles, engines, and handlers |
MsgAttachmentData | |
MsgInspector | |
NetworkError | Networking error |
NoAuthTokenError | Missing authentication token |
NoPermissionsError | Lack of access due to permissions |
NoPermissionsExtendedError | Lack of access due to extended access checks |
NoPolicyError | Classification/labels not configured in tenant policy |
NotSupportedError | Unsupported operation by the SDK |
OperationCancelledError | Operation was cancelled |
ParsedPublishingLicense | |
ParsedPublishingLicenseBuilder | |
PolicyEngine | Interface for all engine functions |
PolicyEngine:Settings | Settings associated with PolicyEngine |
PolicyHandler | Interface for all policy handler functions on a file |
PolicyProfile | Root class for Microsoft Information Protection operations |
PolicyProfile:Observer | Observer interface for profile-related events |
PolicyProfile:Settings | Settings used by PolicyProfile during creation and throughout its lifetime |
PrivilegedRequiredError | Privileged operation label cannot be overridden |
ProtectAdhocAction | Adds adhoc protection to the document |
ProtectAdhocDkAction | Adds adhoc double key protection to the document |
ProtectByEncryptOnlyAction | Adds encrypt only protection to the document |
ProtectByTemplateAction | Adds protection by template to the document |
ProtectDoNotForwardAction | Adds do not forward protection to the document |
ProtectDoNotForwardDkAction | Adds do not forward double key protection to the document |
ProtectionCommonSettings | Settings for protection operations |
ProtectionDescriptor | Description of protection associated with content |
ProtectionDescriptorBuilder | Constructs a ProtectionDescriptor for content protection |
ProtectionEngine | Manages protection-related actions for a specific identity |
ProtectionEngine:Observer | Receives notifications related to ProtectionEngine |
ProtectionEngine:Settings | Settings used by ProtectionEngine throughout its lifetime |
ProtectionHandler | Manages protection actions for specific configuration |
ProtectionHandler:ConsumptionSettings | Settings to consume existing content |
ProtectionHandler:Observer | Receives notifications related to ProtectionHandler |
ProtectionHandler:PublishingSettings | Settings to protect new content |
ProtectionProfile | Root class for performing protection operations |
ProtectionProfile:Observer | Receives notifications related to ProtectionProfile |
ProtectionProfile:Settings | Settings used by ProtectionProfile throughout its lifetime |
ProtectionSettings | Configures protection options for SetLabel method |
ProxyAuthenticationError | Proxy authentication failure |
PublishingLicenseInfo | Details of a Publishing License for protection handler |
PublishingUseLicenseRequest | Request for a use license in the publishing request |
RecommendLabelAction | Suggests a label to the users |
RemoveContentFooterAction | Removes content footer from document |
RemoveContentHeaderAction | Removes content header from document |
RemoveDynamicWatermarkAction | Removes watermark from document |
RemoveProtectionAction | Removes protection from document |
RemoveWatermarkAction | Removes watermark from document |
SensitivityTypesRulePackage | |
ServiceDisabledError | Lack of access due to disabled service |
StorageDelegate | Interface for MIP SDK storage for caching |
StorageDelegate:StorageSettings | Settings used by StorageDelegate |
StorageTable | Interface to MIP SDK storage table for caching |
Stream | Interface between MIP SDK and stream-based content |
TaskDispatcherDelegate | Interface to MIP SDK task dispatcher |
TelemetryDelegate | Interface to MIP SDK telemetry notifications |
TelemetryEvent | A single telemetry event |
TemplateArchivedError | Template ID is archived and unavailable for protection |
TemplateDescriptor | |
TemplateNotFoundError | Template ID not recognized by RMS service |
TenantInformation | Tenant information from RMS |
UniqueIdsAndContentFormats | |
UserRights | Group of users and their associated rights |
UserRoles | Group of users and their associated roles |
xml | |
xml:XmlDelegate | Interface for overriding XML handling |
xml:XmlDocument | Interface to interact with XML document |
xml:XmlLoadException | |
xml:XmlNamespace | |
xml:XmlNode | Defines abstraction over XML node |
xml:XmlParserException | |
xml:XmlReader | XmlReader abstraction class |