Microsoft Information Protection SDK - C 1.17
API Reference Documentation for C
Loading...
Searching...
No Matches
Typedefs | Enumerations | Functions | Variables
protection_descriptor_builder_cc.h File Reference

Defines C-Style ProtectionDescriptorBuilder interface. More...

#include "mip_cc/protection_descriptor_cc.h"

Go to the source code of this file.

Typedefs

typedef mip_cc_handle * mip_cc_protection_descriptor_builder
 

Enumerations

enum  mip_cc_protection_license_type { MIP_PROTECTION_LICENSE_TYPE_DO_NOT_FORWARD = 0 , MIP_PROTECTION_LICENSE_TYPE_ENCRYPT_ONLY = 1 }
 

Functions

 MIP_CC_API (mip_cc_result) MIP_CC_CreateProtectionDescriptorBuilderFromUserRights(const mip_cc_user_rights *userRights
 Creates a protection descriptor whose access permissions are defined by users and rights.
 
 MIP_CC_API (void) MIP_CC_ReleaseProtectionDescriptorBuilder(mip_cc_protection_descriptor_builder protectionDescriptorBuilder)
 Release resources associated with a protection descriptor builder.
 

Variables

const int64_t userRightsCount
 
const int64_t mip_cc_protection_descriptor_builder * protectionDescriptorBuilder
 
const int64_t mip_cc_protection_descriptor_builder mip_cc_error * errorInfo
 
const int64_t userRolesCount
 
const char ** usersWithDefaultRights
 
const char const int64_t usersWithDefaultRightsCount
 
const char const int64_t const mip_cc_user_rights * additionalUsersAndRights
 
const char const int64_t const mip_cc_user_rights const int64_t additionalUsersAndRightsCount
 
const int64_t serializedTemplateSize
 
mip_cc_protection_descriptor * protectionDescriptor
 
const char * name
 
const char * description
 
int64_t contentValidUntil
 
bool allowOfflineAccess
 
const char * uri
 
const mip_cc_dictionary appData
 
const char * doubleKeyUrl
 
const char * labelId
 
const char const char * tenantId
 

Detailed Description

Defines C-Style ProtectionDescriptorBuilder interface.

Typedef Documentation

◆ mip_cc_protection_descriptor_builder

typedef mip_cc_handle* mip_cc_protection_descriptor_builder

Enumeration Type Documentation

◆ mip_cc_protection_license_type

enum mip_cc_protection_license_type
Enumerator
MIP_PROTECTION_LICENSE_TYPE_DO_NOT_FORWARD 

Defines a Do Not Forward License

MIP_PROTECTION_LICENSE_TYPE_ENCRYPT_ONLY 

Defines an Encrypt Only License

Function Documentation

◆ MIP_CC_API() [1/2]

MIP_CC_API ( mip_cc_result ) const

Creates a protection descriptor whose access permissions are defined by users and rights.

Sets the label information for UDP protection.

Sets a double key url for custom protection.

Sets the signed application data for the protection.

Sets the encrypted application data for the protection.

Sets the protection referrer email address.

Sets if protection policy allows offline content access or not.

Sets protection expiration time (in seconds since epoch)

Set the description of the protection.

Set the name of the protection.

Build a protection descriptor from the protection descriptor builder.

Creates a Protection Descriptor Builder whose access permissions are defined by the protection template.

Creates a ProtectionDescriptorBuilder for a license type with the specified users.

Creates a protection descriptor builder based on an existing protection descriptor.

Creates a protection descriptor builder whose access permissions are defined by an RMS template.

Creates a protection descriptor builder whose access permissions are defined by users and roles.

Parameters
userRightsGroups of users and their rights
userRightsCountNumber of user/rights groups
protectionDescriptorBuilder[Output] Newly-created protection descriptor builder instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
userRolesGroups of users and their roles
userRolesCountNumber of user/roles groups
protectionDescriptorBuilder[Output] Newly-created protection descriptor builder instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
templateIdTemplate ID in GUID format
protectionDescriptorBuilder[Output] Newly-created protection descriptor builder instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorThe protection descriptor to base this builder on
protectionDescriptorBuilder[Output] Newly-created protection descriptor builder instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
licenseTypeThe license type to create this Protection Descriptor Builder for
usersWithDefaultRightsCollection of users to add to the license with default rights for the specific type
usersWithDefaultRightsCountNumber of users in the usersWithDefaultRights array
additionalUsersAndRightsOptional additional collection of users-to-rights mappings
additionalUsersAndRightsCountNumber of users in the additionalUsersAndRights array
protectionDescriptorBuilder[Output] Newly-created protection descriptor builder instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
serializedTemplateProtection template
serializedTemplateSizeSize of the serialized template
protectionDescriptorBuilder[Output] Newly-created protection descriptor builder instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
protectionDescriptor[Output] Newly-created protection descriptor instance
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
nameProtection name
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
descriptionProtection description
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorDescriptor associated with protected content
contentValidUntilContent expiration time (in seconds since epoch)
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
allowOfflineAccessIf policy allows offline content access or not
errorInfo[Output] (Optional) Failure info if operation result is error
protectionDescriptorBuilderProtection descriptor builder
uriAddress to referrer unauthenticated users to
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
appDataApplication-specific data to encrypt
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
appDataApplication-specific data for unencrypted section
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
doubleKeyUrlDouble key url
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure
Parameters
protectionDescriptorBuilderProtection descriptor builder
labelIdLabel ID
tenantIdTenant ID
errorInfo[Output] (Optional) Failure info if operation result is error
Returns
Result code indicating success or failure

◆ MIP_CC_API() [2/2]

MIP_CC_API ( void )

Release resources associated with a protection descriptor builder.

Parameters
protectionDescriptorBuilderProtection descriptor builder to be released

Variable Documentation

◆ additionalUsersAndRights

const char const int64_t const mip_cc_user_rights* additionalUsersAndRights

◆ additionalUsersAndRightsCount

const char const int64_t const mip_cc_user_rights const int64_t additionalUsersAndRightsCount

◆ allowOfflineAccess

const int64_t const char const char const char const time_t const bool allowOfflineAccess

◆ appData

const mip_cc_dictionary appData

◆ contentValidUntil

int64_t * contentValidUntil

◆ description

const int64_t const char const char * description

◆ doubleKeyUrl

const char* doubleKeyUrl

◆ errorInfo

const char const char mip_cc_error* errorInfo

◆ labelId

const char* labelId

◆ name

const int64_t const char * name

◆ protectionDescriptor

const int64_t const char const char const char const time_t const bool const mip_cc_dictionary const mip_cc_dictionary mip_cc_protection_descriptor * protectionDescriptor

◆ protectionDescriptorBuilder

const int64_t mip_cc_protection_descriptor_builder * protectionDescriptorBuilder

◆ serializedTemplateSize

const int64_t serializedTemplateSize

◆ tenantId

const char const char* tenantId

◆ uri

const char* uri

◆ userRightsCount

mip_cc_user_rights_result int64_t * userRightsCount

◆ userRolesCount

mip_cc_user_roles_result int64_t * userRolesCount

◆ usersWithDefaultRights

const char** usersWithDefaultRights

◆ usersWithDefaultRightsCount

const char const int64_t usersWithDefaultRightsCount