Diffusion C API  6.5.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
diffusion_change_roles_with_session_id_params_s Struct Reference

Structure supplied when issuing a diffusion_change_roles_with_session_id call. More...

Data Fields

const SESSION_ID_Tsession_id
 Identifies the client session for which the change will be applied. More...
 
const SET_Troles_to_remove
 A set of roles to be removed from the session. More...
 
const SET_Troles_to_add
 A set of roles to be added to the session. More...
 
change_roles_with_session_id_cb on_roles_changed
 Callback when the roles have been successfully changed.
 
ERROR_HANDLER_T on_error
 Callback to handle errors. Can be NULL.
 
DISCARD_HANDLER_T on_discard
 Callback to handle discards. Can be NULL.
 
void * context
 User supplied context. Can be NULL.
 

Detailed Description

Structure supplied when issuing a diffusion_change_roles_with_session_id call.

Field Documentation

const SET_T* diffusion_change_roles_with_session_id_params_s::roles_to_add

A set of roles to be added to the session.

If one or more roles from the list are already assigned, they are ignored.

const SET_T* diffusion_change_roles_with_session_id_params_s::roles_to_remove

A set of roles to be removed from the session.

If one or more roles from the list are not currently assigned, they are ignored.

const SESSION_ID_T* diffusion_change_roles_with_session_id_params_s::session_id

Identifies the client session for which the change will be applied.


The documentation for this struct was generated from the following file: