file security_group.h

Functions

Type Name
int64_t add_security_group_participants (const char * data, uint32_t datalen)
int64_t remove_security_group_participants (const char * data, uint32_t datalen)
bool in_active_security_group (const char * data, uint32_t datalen)
uint32_t get_active_security_group (char * data, uint32_t datalen)

Functions Documentation

function add_security_group_participants

int64_t add_security_group_participants(
    const char * data,
    uint32_t datalen
)

Propose new participants to the security group.

Parameters:

  • data - the buffer containing the packed participants.
  • datalen - size of the packed participants

Precondition:

data is a valid pointer to a range of memory at least datalen bytes long that contains packed participants data

Returns:

-1 if proposing a new security group was unsuccessful, otherwise returns 0.

function remove_security_group_participants

int64_t remove_security_group_participants(
    const char * data,
    uint32_t datalen
)

Propose to remove participants from the security group.

Parameters:

  • data - the buffer containing the packed participants.
  • datalen - size of the packed participants

Precondition:

data is a valid pointer to a range of memory at least datalen bytes long that contains packed participants data

Returns:

-1 if proposing a new security group was unsuccessful, otherwise returns 0.

function in_active_security_group

bool in_active_security_group(
    const char * data,
    uint32_t datalen
)

Check if the specified accounts are all in the active security group.

Parameters:

  • data - the buffer containing the packed participants.
  • datalen - size of the packed participants

Returns:

Returns true if the specified accounts are all in the active security group.

function get_active_security_group

uint32_t get_active_security_group(
    char * data,
    uint32_t datalen
)

Gets the active security group

Parameters:

  • data - the output buffer containing the packed security group.
  • datalen - size of the data buffer

Returns:

Returns the size required in the buffer (if the buffer is too small, nothing is written).


The documentation for this class was generated from the following file: libraries/eosiolib/capi/eosio/security\_group.h