Справочник по пакету SDK MIP для C++MIP SDK for C++ Reference

Пакет SDK для Microsoft Information Protection (MIP) для C++ позволяет разработчикам управлять политиками защиты данных и применять их к данным и другим цифровым ресурсам.The Microsoft Information Protection (MIP) SDK for C++ allows developers to manage and apply data protection policies to data and other digital assets.

Пакет MIP SDK для C++ включает следующее:The MIP SDK for C++ includes:

классы пространства имен MIPnamespace mip classes

КлассClass ОписаниеDescription
класс Акцессдениедеррорclass AccessDeniedError Содержимое недоступно пользователю.The user could not get access to the content. Например, отсутствуют разрешения, или содержимое отозвано.For example, no permissions, content revoked.
Действие классаclass 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)
класс Актиондатаclass ActionData Еще не описано.Not yet documented.
класс Аддконтентфутерактионclass AddContentFooterAction Класс действий, который задает добавление в документ содержимого нижнего колонтитула.An action class that specifies adding a content footer to the document.
класс Аддконтенсеадерактионclass AddContentHeaderAction Класс действий, особенностью которого является добавление содержимого верхнего колонтитула.An action class that specifies adding content header.
класс Аддватермаркактионclass AddWatermarkAction Класс действий, особенностью которого является добавление водяного знака.An action class that specifies adding watermark.
класс Аддватермаркактиондатаclass AddWatermarkActionData Еще не описано.Not yet documented.
класс Адхокпротектионрекуиредеррорclass AdhocProtectionRequiredError Для завершения действия с файлом необходимо установить защиту от нерегламентированного компьютера.Adhoc protection should be set to complete the action on the file.
класс Аппликатионактионстатеclass ApplicationActionState Еще не описано.Not yet documented.
класс Апплилабелактионclass ApplyLabelAction Этот класс требует, чтобы вызывающее приложение применило определенную метку.Apply label actions requires the calling application to apply a specific label.
класс Аргументдатаclass ArgumentData Еще не описано.Not yet documented.
класс AsyncControlclass AsyncControl Класс, используемый для отмены асинхронной операции.Class used to cancel async operation.
класс Аусделегатеclass AuthDelegate Делегат для операций, связанных с проверкой подлинности.Delegate for auth related operations.
класс Бадинпутеррорclass BadInputError Ошибка неправильного ввода происходит, если в API пакета SDK поступают недопустимые данные.Bad input error, thrown when the input to an SDK API is invalid.
класс Классификатиондатаclass ClassificationData Еще не описано.Not yet documented.
класс Классификатионрекуестclass ClassificationRequest Класс, содержащий запрос на вызов классификации в состоянии выполнения.Class that contains the request of a classification call on the Execution State.
класс Классификатионресултclass ClassificationResult Класс, содержащий результат вызова классификации для состояния выполнения.Class that contains the result of a classification call on the Execution State.
класс Компутингинеclass ComputeEngine Еще не описано.Not yet documented.
класс Компутингинеконтекстclass ComputeEngineContext Еще не описано.Not yet documented.
класс Кондитиондатаclass ConditionData Еще не описано.Not yet documented.
Класс ConsentDelegateclass ConsentDelegate Делегат для операций, связанных с согласием.Delegate for consent related operations.
класс Консентдениедеррорclass ConsentDeniedError Операции, которой требуется согласие пользователя, согласие не предоставлено.An operation that required consent from user was not granted consent.
класс Протектионхандлер:: Консумптионсеттингсclass ProtectionHandler::ConsumptionSettings Параметры, используемые для создания Протектионхандлер для использования существующего содержимого.Settings used to create a ProtectionHandler to consume existing content.
класс ContentLabelclass ContentLabel Абстракция для метки Microsoft Information Protection, которая применяется к части содержимого, обычно к документу.Abstraction for a Microsoft Information Protection label that is applied to a piece of content, typically a document.
класс Контентмаркингактиондатаclass ContentMarkingActionData Еще не описано.Not yet documented.
CustomAction классаclass CustomAction 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.
класс Депрекатедапиеррорclass DeprecatedApiError Вызывающий объект вызвал устаревший API.Caller invoked a deprecated API.
класс Детаиледклассификатионресултclass DetailedClassificationResult Класс, содержащий результат вызова классификации для состояния выполнения.Class that contains the result of a classification call on the Execution State.
класс Документстатеclass DocumentState Еще не описано.Not yet documented.
Ошибка классаclass Error Базовый класс для всех ошибок, о которых будет сообщено (через возвращение) из пакетов MIP SDK.Base class for all errors that will be reported (thrown or returned) from MIP SDK.
класс Ексекутионстатеclass ExecutionState Интерфейс для всех состояний, которые необходимы для запуска подсистемы.Interface for all the state needed to execute the engine.
класс Филингинеclass FileEngine Этот класс предоставляет интерфейс для всех функций подсистемы.This class provides an interface for all engine functions.
класс Филиксекутионстатеclass FileExecutionState Еще не описано.Not yet documented.
класс FileHandlerclass FileHandler Интерфейс для всех функций обработки файлов.Interface for all file handling functions.
класс Филеинспекторclass FileInspector Еще не описано.Not yet documented.
класс Филеиоеррорclass FileIOError Ошибка файлового ввода-вывода.File IO error.
класс FileProfileclass FileProfile FileProfile — это корневой класс для использования операций Microsoft Information Protection.FileProfile class is the root class for using the Microsoft Information Protection operations.
класс Хттпделегатеclass HttpDelegate Интерфейс для переопределения HTTP-обработки.Interface for overriding HTTP handling.
класс Хттпоператионclass HttpOperation Интерфейс, описывающий одну операцию HTTP, реализованную клиентским приложением при переопределении Хттпделегате.Interface that describes a single HTTP operation, implemented by client app when overriding HttpDelegate.
класс HttpRequestclass HttpRequest Интерфейс, который описывает один HTTP-запрос.Interface that describes a single HTTP request.
класс HttpResponseclass HttpResponse Интерфейс, который описывает один HTTP-ответ, реализованный клиентским приложением при переопределении HttpDelegate.Interface that describes a single HTTP response, implemented by client app when overriding HttpDelegate.
Удостоверение классаclass Identity Абстракция для Identity.Abstraction for identity.
класс ИнсуффиЦиентбуффереррорclass InsufficientBufferError Недостаточно ошибок в буфере.Insufficient buffer error.
класс Интерналеррорclass InternalError Внутренняя ошибка.Internal error. Такая ошибка возникает, когда во время выполнения происходит что-то непредвиденное.This error is thrown when something unexpected happens during execution.
класс JustificationRequiredErrorclass JustificationRequiredError Еще не описано.Not yet documented.
класс Жустифяктионclass JustifyAction Действие по выравниванию требует задать тип выравнивания для понижения уровня метки и указать ответ на этапе выполнения.Justify Action requires providing a justification to a label downgrade and setting the response in the execution state.
Метка классаclass Label Абстракция для единой метки Microsoft Information Protection.Abstraction for a single Microsoft Information Protection label.
класс Лабелактиондатаclass LabelActionData Еще не описано.Not yet documented.
класс Лабелдисабледеррорclass LabelDisabledError Метка отключена или неактивна.Label is disabled or inactive.
класс Лабелграупдатаclass LabelGroupData Еще не описано.Not yet documented.
класс Лабелингоптионсclass LabelingOptions Интерфейс, в котором настраиваются параметры добавления меток для метода SetLabel или DeleteLabel.Interface for configuring labeling options for the SetLabel/DeleteLabel methods.
класс Лабелнотфаундеррорclass LabelNotFoundError ИДЕНТИФИКАТОР метки не распознан.Label ID is not recognized.
класс Лиценсенотрегистередеррорclass LicenseNotRegisteredError Лицензия не зарегистрирована.License is not registered.
класс Логжерделегатеclass LoggerDelegate Класс, который определяет интерфейс для средства ведения журнала пакета MIP SDK.A class that defines the interface to the MIP SDK logger.
класс Метадатаактионclass MetadataAction Действие, которое добавляет метаданные к содержимому.An Action that adds metadata information to the content.
класс Метадатаентриclass MetadataEntry Класс абстракции для записи метаданных.An abstraction class for metadata entry.
класс Метадатаверсионclass MetadataVersion Интерфейс для Метадатаверсион.Interface for a MetadataVersion. Метадатаверсион определяет, какие метаданные являются активными и как они обрабатываются.MetadataVersion determines which metadata is active and how it is processed.
класс Мипконтекстclass MipContext Мипконтекст представляет состояние, которое является общим для всех профилей, ядер, обработчиков.MipContext represents state that is shared across all profiles, engines, handlers.
класс Мсгаттачментдатаclass MsgAttachmentData Еще не описано.Not yet documented.
класс Мсгинспекторclass MsgInspector Еще не описано.Not yet documented.
класс NetworkErrorclass NetworkError Сетевая ошибка.Networking error. Происходит при непредвиденном поведении во время вызова по сети к конечным точкам службы.Caused by unexpected behavior when making network calls to service endpoints.
класс Ноаустокенеррорclass NoAuthTokenError Пользователю не удалось получить доступ к содержимому из-за отсутствия маркера проверки подлинности.The user could not get access to the content due to missing authentication token.
класс Нопермиссионсеррорclass NoPermissionsError Содержимое недоступно пользователю.The user could not get access to the content. Например, отсутствуют разрешения, или содержимое отозвано.For example, no permissions, content revoked.
класс Нополициеррорclass NoPolicyError Политика клиента не настроена для классификации или меток.Tenant policy is not configured for classification/labels.
класс Нотсуппортедеррорclass NotSupportedError Операция, запрошенная приложением, не поддерживается пакетом SDK.The operation requested by the application is not supported by the SDK.
класс Аусделегате:: OAuth2Challengeclass AuthDelegate::OAuth2Challenge класс, содержащий все сведения, необходимые из вызывающего приложения для создания токена OAuth2.a class that contains all the information required from the calling application in order to generate an oauth2 token.
класс Аусделегате:: OAuth2Tokenclass AuthDelegate::OAuth2Token Класс, содержащий сведения о маркере доступа, предоставляемые приложением.A class containing access token info provided by an application.
класс FileHandler:: наблюдательclass FileHandler::Observer Интерфейс Observer для получения клиентами уведомлений о событиях, связанных с обработчиком файла.Observer interface for clients to get notifications events related to file handler.
класс Протектионенгине:: наблюдательclass ProtectionEngine::Observer Интерфейс, который получает уведомления, связанные с ProtectionEngine.Interface that receives notifications related to ProtectionEngine.
класс FileProfile:: наблюдательclass FileProfile::Observer Клиентский интерфейс Observer для получения уведомлений о событиях, связанных с профилем.Observer interface for clients to get notifications for profile related events.
класс Полиципрофиле:: наблюдательclass PolicyProfile::Observer Клиентский интерфейс Observer для получения уведомлений о событиях, связанных с профилем.Observer interface for clients to get notifications for profile related events.
класс Протектионхандлер:: наблюдательclass ProtectionHandler::Observer Интерфейс, который получает уведомления, связанные с ProtectionHandler.Interface that receives notifications related to ProtectionHandler.
класс ProtectionProfile:: наблюдательclass ProtectionProfile::Observer Интерфейс, который получает уведомления связанные с ProtectionProfile.Interface that receives notifications related to ProtectionProfile.
класс Оператионканцелледеррорclass OperationCancelledError Операция отменена.Operation was cancelled.
класс PolicyEngineclass PolicyEngine Этот класс предоставляет интерфейс для всех функций подсистемы.This class provides an interface for all engine functions.
класс Полицихандлерclass PolicyHandler Этот класс предоставляет интерфейс для всех функций обработчика политики.This class provides an interface for all policy handler functions on a file.
класс Полиципаккажедатаclass PolicyPackageData Еще не описано.Not yet documented.
класс Полиципрофилеclass PolicyProfile Класс PolicyProfile является корневым классом для операции Microsoft Information Protection.PolicyProfile class is the root class for using the Microsoft Information Protection operations. Типичному приложению нужен только один PolicyProfile, но при необходимости можно создать несколько профилей.A typical application will only need one PolicyProfile but it can create multiple profiles if needed.
класс Полицируледатаclass PolicyRuleData Еще не описано.Not yet documented.
класс Привилежедрекуиредеррорclass PrivilegedRequiredError Текущая метка была назначена привилегированной операцией (эквивалент действий администратора) и поэтому не может быть переопределена.Current label was assigned as a privileged operation (The equivalent to an administrator operation), therefore it can't be overriden.
класс PropertyDataclass PropertyData Еще не описано.Not yet documented.
класс Протектадхокактионclass ProtectAdhocAction Класс действий, предписывающий необходимость обеспечения изначальной защиты документа.An action class that specifies adding adhoc protection to the document.
класс Протектадхокдкактионclass ProtectAdhocDkAction Класс действия, указывающий Добавление безрегламентированной защиты ключа в документ.An action class that specifies adding adhoc double key protection to the document.
класс Протектбенкриптонляктионclass ProtectByEncryptOnlyAction Класс действий, указывающий Добавление защиты только шифрования в документ.An action class that specifies adding encrypt only protection to the document.
класс Протектбитемплатеактионclass ProtectByTemplateAction Класс действий, который задает добавление в документ защиты по шаблону.An action class that specifies adding protection by template to the document.
класс Протектдонотфорвардактионclass ProtectDoNotForwardAction Класс действий, который задает добавление в документ защиты "Не пересылать".An action class that specifies adding do not forward protection to the document.
класс Протектдонотфорварддкактионclass ProtectDoNotForwardDkAction Класс действия, указывающий Добавление в документ функций не пересылать двойную защиту ключей.An action class that specifies adding do not forward double key protection to the document.
класс Протектионактиондатаclass ProtectionActionData Еще не описано.Not yet documented.
класс Протектиондескрипторclass ProtectionDescriptor Описание защиты, связанной с фрагментом содержимого.Description of protection associated with a piece of content.
класс Протектиондескрипторбуилдерclass ProtectionDescriptorBuilder Создает элемент ProtectionDescriptor, описывающий защиту, связанную с содержимым.Constructs a ProtectionDescriptor that describes protection associated with a piece of content.
класс Протектионенгинеclass ProtectionEngine Управляет действиями, связанными с защитой и определенным удостоверением.Manages protection-related actions related to a specific identity.
класс Протектионхандлерclass ProtectionHandler Управляет действиями, связанными с защитой, для определенной конфигурации защиты.Manages protection-related actions for a specific protection configuration.
класс ProtectionProfileclass ProtectionProfile ProtectionProfile — это корневой класс для выполнения операций защиты.ProtectionProfile is the root class for performing protection operations.
класс Протектионсеттингсclass ProtectionSettings Интерфейс для настройки параметров защиты для метода SetLabel.Interface for configuring protection options for the SetLabel method.
класс Проксяусентикатионеррорclass ProxyAuthenticationError Сбой проверки подлинности прокси-сервера.Proxy authentication failure.
класс Публишинглиценсеинфоclass PublishingLicenseInfo Структура, хранящая сведения о лицензии на публикацию, используемые для создания обработчика защиты.Holds the details of a Publishing License used to create a protection handler.
класс Протектионхандлер::P Ублишингсеттингсclass ProtectionHandler::PublishingSettings Параметры, используемые для создания Протектионхандлер для защиты нового содержимого.Settings used to create a ProtectionHandler to protect new content.
класс Рекоммендлабелактионclass 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.
класс Ремовеконтентфутерактионclass RemoveContentFooterAction Класс действий, задающий удаление содержимого нижнего колонтитула из документа.An action class that specifies removing the content footer from the document.
класс Ремовеконтенсеадерактионclass RemoveContentHeaderAction Класс действий, задающий удаление содержимого верхнего колонтитула из документа.An action class that specifies removing the content header from the document.
класс Ремовепротектионактионclass RemoveProtectionAction Класс действий, задающий удаление защиты из документа.An action class that specifies removing protection from the document.
класс Ремовеватермаркактионclass RemoveWatermarkAction Класс действий, задающий удаление водяного знака из документа.An action class that specifies removing the watermarking from the document.
класс Рулепаккажедатаclass RulePackageData Еще не описано.Not yet documented.
класс Сенситиветипеклассификатиондатаclass SensitiveTypeClassificationData Еще не описано.Not yet documented.
класс Сенситивитикондитиондатаclass SensitivityConditionData Еще не описано.Not yet documented.
класс Сенситивититипесрулепаккажеclass SensitivityTypesRulePackage Еще не описано.Not yet documented.
класс Сервицедисабледеррорclass ServiceDisabledError Пользователю не удалось получить доступ к содержимому из-за отключенной службы.The user could not get access to the content due to a service being disabled.
класс Филингине:: Settingsclass FileEngine::Settings Еще не описано.Not yet documented.
класс PolicyEngine:: Settingsclass PolicyEngine::Settings Определяет параметры, связанные с PolicyEngine.Defines the settings associated with a PolicyEngine.
класс Полиципрофиле:: Settingsclass PolicyProfile::Settings Параметры, используемые объектом PolicyProfile при его создании и на протяжении всего времени существования.Settings used by PolicyProfile during its creation and throughout its lifetime.
класс ProtectionProfile:: Settingsclass ProtectionProfile::Settings Параметры, используемые профилем ProtectionProfile, во время его создания и на протяжении всего времени его существования.Settings used by ProtectionProfile during its creation and throughout its lifetime.
класс FileProfile:: Settingsclass FileProfile::Settings Параметры, используемые профилем FileProfile при его создании и на протяжении всего времени существования.Settings used by FileProfile during its creation and throughout its lifetime.
класс Компутингине:: Settingsclass ComputeEngine::Settings Еще не описано.Not yet documented.
класс Протектионенгине:: Settingsclass ProtectionEngine::Settings Параметры, используемые подсистемой ProtectionEngine при ее создании и на протяжении всего времени существования.Settings used by ProtectionEngine during its creation and throughout its lifetime.
Поток классаclass Stream Класс, который определяет интерфейс между пакетом MIP SDK и содержимым потока.A class that defines the interface between the MIP SDK and stream-based content.
класс Синкфилебаседатаclass SyncFileBaseData Еще не описано.Not yet documented.
класс Синкфилеполицидатаclass SyncFilePolicyData Еще не описано.Not yet documented.
класс Синкфилесенситивитидатаclass SyncFileSensitivityData Еще не описано.Not yet documented.
класс Таскдиспатчерделегатеclass TaskDispatcherDelegate Класс, определяющий интерфейс для диспетчера задач MIP SDK.A class that defines the interface to the MIP SDK task dispatcher.
класс TemplateDescriptorclass TemplateDescriptor Еще не описано.Not yet documented.
класс Темплатенотфаундеррорclass TemplateNotFoundError Служба RMS не распознает идентификатор шаблона.Template ID is not recognized by RMS service.
класс UserRightsclass UserRights Группа пользователей и связанных с ними прав.A group of users and the rights associated with them.
класс UserRolesclass UserRoles Группа пользователей и связанных с ними ролей.A group of users and the roles associated with them.