MIP SDK for C Reference
The Microsoft Information Protection (MIP) SDK for C allows developers to manage and apply data protection policies to data and other digital assets.
The MIP SDK for C includes
- Enumerations
- Structures
- The following functions:
| Function | Brief description |
|---|---|
| mip_cc_auth_callback | callback function definition for acquiring OAuth2 token |
| mip_cc_consent_callback | callback function definition for consent from user to access external service endpoint |
| MIP_CC_CreateDictionary | Create a dictionary of string keys/values |
| MIP_CC_Dictionary_GetEntries | Get key/value pairs that compose a dictionary |
| MIP_CC_ReleaseDictionary | Release resources associated with a dictionary |
| mip_cc_http_send_callback_fn | Callback function definition for issuing an HTTP request |
| mip_cc_http_cancel_callback_fn | Callback function definition for cancelling an HTTP request |
| MIP_CC_CreateHttpDelegate | Creates an HTTP delegate which can be used to override MIP's default HTTP stack |
| MIP_CC_NotifyHttpDelegateResponse | Notifies an HTTP delegate that an HTTP response is ready |
| MIP_CC_ReleaseHttpDelegate | Release resources associated with an HTTP delegate handle |
| mip_cc_logger_init_callback_fn | Callback function definition for initialization of logger |
| mip_cc_logger_write_callback_fn | Callback function definition for writing a log statement |
| MIP_CC_CreateLoggerDelegate | Creates a logger delegate which can be used to override MIP's default logger |
| MIP_CC_ReleaseLoggerDelegate | Release resources associated with an logger delegate handle |
| MIP_CC_CreateMipContext | Create a MIP context to manage state shared across all profile instances |
| MIP_CC_CreateMipContextWithCustomFeatureSettings | Create a MIP context to manage state shared across all profile instances |
| MIP_CC_ReleaseMipContext | Release resources associated with a MIP context |
| MIP_CC_ProtectionDescriptor_GetProtectionType | Gets type of protection, whether it is defined by an RMS template or not |
| MIP_CC_ProtectionDescriptor_GetOwnerSize | Gets size of buffer required to store owner |
| MIP_CC_ProtectionDescriptor_GetOwner | Gets protection owner |
| MIP_CC_ProtectionDescriptor_GetNameSize | Gets size of buffer required to store name |
| MIP_CC_ProtectionDescriptor_GetName | Gets protection name |
| MIP_CC_ProtectionDescriptor_GetDescriptionSize | Gets size of buffer required to store description |
| MIP_CC_ProtectionDescriptor_GetDescription | Gets protection description |
| MIP_CC_ProtectionDescriptor_GetTemplateId | Gets template ID |
| MIP_CC_ProtectionDescriptor_GetLabelId | Gets label ID |
| MIP_CC_ProtectionDescriptor_GetContentId | Gets content ID |
| MIP_CC_ProtectionDescriptor_DoesContentExpire | Gets whether or not content has an expiration time or not |
| MIP_CC_ProtectionDescriptor_GetContentValidUntil | Gets protection expiration time (in seconds since epoch) |
| MIP_CC_ProtectionDescriptor_DoesAllowOfflineAccess | Gets whether or not offline access is allowed |
| MIP_CC_ProtectionDescriptor_GetReferrerSize | Gets size of buffer required to store referrer |
| MIP_CC_ProtectionDescriptor_GetReferrer | Gets protection referrer |
| MIP_CC_ProtectionDescriptor_GetDoubleKeyUrlSize | Gets size of buffer required to store double key URL |
| MIP_CC_ProtectionDescriptor_GetDoubleKeyUrl | Gets double key URL |
| MIP_CC_ReleaseProtectionDescriptor | Release resources associated with a protection descriptor |
| MIP_CC_CreateStringList | Create a string list |
| MIP_CC_StringList_GetStrings | Get strings that compose a string list |
| MIP_CC_ReleaseStringList | Release resources associated with a string list |
| mip_cc_dispatch_task_callback_fn | Callback function definition for dispatching an async task |
| mip_cc_cancel_task_callback_fn | Callback function for canceling a background tasks |
| MIP_CC_CreateTaskDispatcherDelegate | Creates a task dispatcher delegate which can be used to override MIP's default async task handling |
| MIP_CC_ExecuteDispatchedTask | Notifies a TaskDispatcher delegate that a task is scheduled to execute now on the current thread |
| MIP_CC_ReleaseTaskDispatcherDelegate | Release resources associated with an task dispatcher delegate handle |
| MIP_CC_CreateTelemetryConfiguration | Create a settings object used to create a protection profile |
| MIP_CC_TelemetryConfiguration_SetHostName | Set a telemetry host name which will override internal telemetry settings |
| MIP_CC_TelemetryConfiguration_SetLibraryName | Set a telemetry shared library override |
| MIP_CC_TelemetryConfiguration_SetHttpDelegate | Override default telemetry HTTP stack with client's own |
| MIP_CC_TelemetryConfiguration_SetTaskDispatcherDelegate | Override default async task dispatcher with client's own |
| MIP_CC_TelemetryConfiguration_SetIsNetworkDetectionEnabled | Sets whether or not the telemetry component is allowed ping network status on a background thread |
| MIP_CC_TelemetryConfiguration_SetIsLocalCachingEnabled | Sets whether or not the telemetry component is allowed to write caches to disk |
| MIP_CC_TelemetryConfiguration_SetIsTraceLoggingEnabled | Sets whether or not the telemetry component is allowed to write logs to disk |
| MIP_CC_TelemetryConfiguration_SetIsTelemetryOptedOut | Sets whether or not an application/user has opted out of optional telemetry |
| MIP_CC_TelemetryConfiguration_SetCustomSettings | Sets custom telemetry settings |
| MIP_CC_TelemetryConfiguration_AddMaskedProperty | Sets a telemetry property to mask |
| MIP_CC_ReleaseTelemetryConfiguration | Release resources associated with a protection profile settings |
| MIP_CC_TemplateDescriptor_GetId | Gets template ID |
| MIP_CC_TemplateDescriptor_GetNameSize | Gets size of buffer required to store name |
| MIP_CC_TemplateDescriptor_GetName | Gets Template name |
| MIP_CC_TemplateDescriptor_GetDescriptionSize | Gets size of buffer required to store description |
| MIP_CC_TemplateDescriptor_GetDescription | Gets Template description |
| MIP_CC_ReleaseTemplateDescriptor | Release resources associated with a template descriptor |
| MIP_CC_ActionResult_GetActions | Get actions that compose an action result |
| MIP_CC_ReleaseActionResult | Release resources associated with an action result |
| MIP_CC_AddContentFooterAction_GetUIElementNameSize | Gets size of buffer required to store an "add content footer" action's UI element name |
| MIP_CC_AddContentFooterAction_GetUIElementName | Gets an "add content footer" action's UI element name |
| MIP_CC_AddContentFooterAction_GetTextSize | Gets size of buffer required to store an "add content footer" action's text |
| MIP_CC_AddContentFooterAction_GetText | Gets an "add content footer" action's text |
| MIP_CC_AddContentFooterAction_GetFontNameSize | Gets size of buffer required to store an "add content footer" action's font name |
| MIP_CC_AddContentFooterAction_GetFontName | Gets an "add content footer" action's font name |
| MIP_CC_AddContentFooterAction_GetFontSize | Gets the integer font size |
| MIP_CC_AddContentFooterAction_GetFontColorSize | Gets size of buffer required to store an "add content footer" action's font color |
| MIP_CC_AddContentFooterAction_GetFontColor | Gets an "add content footer" action's font color (for example, "#000000") |
| MIP_CC_AddContentFooterAction_GetAlignment | Gets the alignment |
| MIP_CC_AddContentFooterAction_GetMargin | Gets the margin size |
| MIP_CC_AddContentHeaderAction_GetUIElementNameSize | Gets size of buffer required to store an "add content header" action's UI element name |
| MIP_CC_AddContentHeaderAction_GetUIElementName | Gets an "add content header" action's UI element name |
| MIP_CC_AddContentHeaderAction_GetTextSize | Gets size of buffer required to store an "add content header" action's text |
| MIP_CC_AddContentHeaderAction_GetText | Gets an "add content header" action's text |
| MIP_CC_AddContentHeaderAction_GetFontNameSize | Gets size of buffer required to store an "add content header" action's font name |
| MIP_CC_AddContentHeaderAction_GetFontName | Gets an "add content header" action's font name |
| MIP_CC_AddContentHeaderAction_GetFontSize | Gets the integer font size |
| MIP_CC_AddContentHeaderAction_GetFontColorSize | Gets size of buffer required to store an "add content header" action's font color |
| MIP_CC_AddContentHeaderAction_GetFontColor | Gets an "add content header" action's font color (for example, "#000000") |
| MIP_CC_AddContentHeaderAction_GetAlignment | Gets the alignment |
| MIP_CC_AddContentHeaderAction_GetMargin | Gets the margin size |
| MIP_CC_AddWatermarkAction_GetUIElementNameSize | Gets size of buffer required to store an "add watermark" action's UI element name |
| MIP_CC_AddWatermarkAction_GetUIElementName | Gets an "add watermark" action's UI element name |
| MIP_CC_AddWatermarkAction_GetLayout | Gets the watermark layout |
| MIP_CC_AddWatermarkAction_GetTextSize | Gets size of buffer required to store an "add watermark" action's text |
| MIP_CC_AddWatermarkAction_GetText | Gets an "add watermark" action's text |
| MIP_CC_AddWatermarkAction_GetFontNameSize | Gets size of buffer required to store an "add watermark" action's font name |
| MIP_CC_AddWatermarkAction_GetFontName | Gets an "add watermark" action's font name |
| MIP_CC_AddWatermarkAction_GetFontSize | Gets the integer font size |
| MIP_CC_AddWatermarkAction_GetFontColorSize | Gets size of buffer required to store an "add watermark" action's font color |
| MIP_CC_AddWatermarkAction_GetFontColor | Gets an "add watermark" action's font color (for example, "#000000") |
| MIP_CC_ReleaseContentLabel | Release resources associated with a content label |
| MIP_CC_ContentLabel_GetCreationTime | Gets time when label was applied |
| MIP_CC_ContentLabel_GetAssignmentMethod | Gets label assignment method |
| MIP_CC_ContentLabel_GetExtendedProperties | Gets extended properties |
| MIP_CC_ContentLabel_IsProtectionAppliedFromLabel | Gets whether or not a protection was applied by a label. |
| MIP_CC_ContentLabel_GetLabel | Gets generic label properties from a content label instance |
| MIP_CC_CustomAction_GetNameSize | Gets size of buffer required to store a "custom" action's name |
| MIP_CC_CustomAction_GetName | Gets a "custom" action's name |
| MIP_CC_CustomAction_GetProperties | Gets a "custom" action's properties |
| MIP_CC_ReleaseLabel | Release resources associated with a label |
| MIP_CC_Label_GetId | Gets label ID |
| MIP_CC_Label_GetNameSize | Gets size of buffer required to store name |
| MIP_CC_Label_GetName | Gets label name |
| MIP_CC_Label_GetDescriptionSize | Gets size of buffer required to store description |
| MIP_CC_Label_GetDescription | Gets label description |
| MIP_CC_Label_GetColorSize | Gets size of buffer required to store color |
| MIP_CC_Label_GetColor | Gets label color |
| MIP_CC_Label_GetSensitivity | Gets sensitivity level of label. Higher value means more sensitive. |
| MIP_CC_Label_GetTooltipSize | Gets size of buffer required to store tooltip |
| MIP_CC_Label_GetTooltip | Gets label tooltip |
| MIP_CC_Label_GetAutoTooltipSize | Gets size of buffer required to store auto-classification tooltip |
| MIP_CC_Label_GetAutoTooltip | Gets label auto-classification tooltip |
| MIP_CC_Label_IsActive | Gets whether or not a label is active |
| MIP_CC_Label_GetParent | Gets the parent label, if any |
| MIP_CC_Label_GetChildrenSize | Gets the number of children labels |
| MIP_CC_Label_GetChildren | Gets the children labels |
| MIP_CC_Label_GetCustomSettings | Gets policy-defined custom settings of a label |
| MIP_CC_MetadataAction_GetMetadataToRemove | Gets a "metadata" action's metadata to remove |
| MIP_CC_MetadataAction_GetMetadataToAdd | Gets a "metadata" action's metadata to add |
| MIP_CC_CreateMetadataDictionary | Create a dictionary of string keys/values |
| MIP_CC_MetadataDictionary_GetEntries | Get metadata entries that compose a dictionary |
| MIP_CC_ReleaseMetadataDictionary | Release resources associated with a dictionary |
| MIP_CC_ReleasePolicyHandler | Release resources associated with a policy handler |
| MIP_CC_PolicyHandler_GetSensitivityLabel | Gets a document's current label |
| MIP_CC_PolicyHandler_ComputeActions | Executes policy rules based on the provided state and determines corresponding actions |
| MIP_CC_PolicyHandler_NotifyCommittedActions | Called by application after computed actions have been applied and data committed to disk |
| MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrlSize | Gets size of buffer required to store the double key encryption url. |
| MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrl | Gets double key encryption url |
| MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrlSize | Gets size of buffer required to store the double key encryption url. |
| MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrl | Gets double key encryption url |
| MIP_CC_RemoveContentFooterAction_GetUIElementNames | Gets a "remove content footer" action's UI element names to remove |
| MIP_CC_RemoveContentHeaderAction_GetUIElementNames | Gets a "remove content header" action's UI element names to remove |
| MIP_CC_RemoveWatermarkAction_GetUIElementNames | Gets a "remove watermark" action's UI element names to remove |
| MIP_CC_ReleaseSensitivityType | Release resources associated with a sensitivity type |
| MIP_CC_SensitivityType_GetRulePackageIdSize | Gets size of buffer required to store a sensitivity type's rule package ID |
| MIP_CC_SensitivityType_GetRulePackageId | Gets a sensitivity type's rule package ID |
| MIP_CC_SensitivityType_GetRulePackageSize | Gets size of buffer required to store a sensitivity type's rule package |
| MIP_CC_SensitivityType_GetRulePackage | Gets a sensitivity type's rule package |