Microsoft Information Protection SDK - C 1.17
API Reference Documentation for C
Loading...
Searching...
No Matches
user_rights_roles_cc.h File Reference

Defines C-Style user rights & roles functions. More...

Go to the source code of this file.

Functions

 MIP_CC_API (mip_cc_result) MIP_CC_UserRights_GetUsers(const mip_cc_user_rights_result userRights
 Gets the list of users from a single users-to-rights pair. This API is identical to calling protectionDescriptor->GetUserRights()[index].Users() on the C++ side.
 
 MIP_CC_API (void) MIP_CC_ReleaseUserRightsResult(mip_cc_user_rights_result userRightsList)
 Release resources associated with a user rights list.
 

Variables

uint32_t index
 
uint32_t mip_cc_string_listusers
 
uint32_t mip_cc_string_list mip_cc_errorerrorInfo
 
uint32_t mip_cc_string_listrights
 
uint32_t mip_cc_string_listroles
 

Detailed Description

Defines C-Style user rights & roles functions.

Function Documentation

◆ MIP_CC_API() [1/2]

MIP_CC_API ( mip_cc_result ) const

Gets the list of users from a single users-to-rights pair. This API is identical to calling protectionDescriptor->GetUserRights()[index].Users() on the C++ side.

Gets the list of roles from a single users-to-roles pair. This API is identical to calling protectionDescriptor->GetUserRoles()[index].Roles() on the C++ side.

Gets the list of users from a single users-to-roles pair. This API is identical to calling protectionDescriptor->GetUserRoles()[index].Users() on the C++ side.

Gets the list of rights from a single users-to-rights pair. This API is identical to calling protectionDescriptor->GetUserRights()[index].Rights() on the C++ side.

Parameters
userRightsThe users-to-rights list to access
indexWhich users-to-rights pair to retrieve the list of users from
users[Output] The retrieved users list. It is the caller's responsibility to release this object with MIP_CC_ReleaseStringList
errorInfo[Output] (Optional) Failure info if operation result is error
userRightsThe users-to-rights list to access
indexWhich users-to-rights pair to retrieve the list of rights from
rights[Output] The retrieved rights list. It is the caller's responsibility to release this object with MIP_CC_ReleaseStringList
errorInfo[Output] (Optional) Failure info if operation result is error
userRolesThe users-to-roles list to access
indexWhich users-to-roles pair to retrieve the list of users from
users[Output] The retrieved users list. It is the caller's responsibility to release this object with MIP_CC_ReleaseStringList
errorInfo[Output] (Optional) Failure info if operation result is error
userRolesThe users-to-roles list to access
indexWhich users-to-roles pair to retrieve the list of roles from
roles[Output] The retrieved roles list. It is the caller's responsibility to release this object with MIP_CC_ReleaseStringList
errorInfo[Output] (Optional) Failure info if operation result is error

◆ MIP_CC_API() [2/2]

MIP_CC_API ( void )

Release resources associated with a user rights list.

Release resources associated with a user roles list.

Parameters
userRightsListUser rights list to be released
userRightsListUser roles list to be released

Variable Documentation

◆ errorInfo

uint32_t mip_cc_string_list mip_cc_error* errorInfo

◆ index

uint32_t index

◆ rights

uint32_t mip_cc_string_list* rights

◆ roles

uint32_t mip_cc_string_list* roles

◆ users

uint32_t mip_cc_string_list* users