user_rights_roles_cc.h File Reference

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

#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/protection_descriptor_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/string_list_cc.h"

Include dependency graph for user_rights_roles_cc.h:

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.
	MIP_CC_API (void) MIP_CC_ReleaseUserRightsResult(mip_cc_user_rights_result userRightsList)
	Release resources associated with a user rights list.

Variables
uint32_t mip_cc_string_list mip_cc_error *	errorInfo
uint32_t	index
uint32_t mip_cc_string_list *	rights
uint32_t mip_cc_string_list *	roles
uint32_t mip_cc_string_list *	users

Detailed Description

Defines C-Style user rights & roles functions.

Definition in file user_rights_roles_cc.h.

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.

Gets the list of roles from a single users-to-roles pair.

Gets the list of users from a single users-to-roles pair.

Gets the list of rights from a single users-to-rights pair.

This API is identical to calling protectionDescriptor->GetUserRights()[index].Users() on the C++ side.

Parameters

userRights	The users-to-rights list to access
index	Which 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

This API is identical to calling protectionDescriptor->GetUserRights()[index].Rights() on the C++ side.

Parameters

userRights	The users-to-rights list to access
index	Which 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

This API is identical to calling protectionDescriptor->GetUserRoles()[index].Users() on the C++ side.

Parameters

userRoles	The users-to-roles list to access
index	Which 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

This API is identical to calling protectionDescriptor->GetUserRoles()[index].Roles() on the C++ side.

Parameters

userRoles	The users-to-roles list to access
index	Which 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

userRightsList	User rights list to be released
userRightsList	User roles list to be released

Variable Documentation

errorInfo

uint32_t mip_cc_string_list mip_cc_error* errorInfo

Definition at line 57 of file user_rights_roles_cc.h.

index

uint32_t index

Definition at line 55 of file user_rights_roles_cc.h.

rights

uint32_t mip_cc_string_list* rights

Definition at line 71 of file user_rights_roles_cc.h.

roles

uint32_t mip_cc_string_list* roles

Definition at line 108 of file user_rights_roles_cc.h.

users

uint32_t mip_cc_string_list* users

Definition at line 56 of file user_rights_roles_cc.h.