EOS API reference page for EOS_KWS_CopyPermissionByIndex

2 mins to read

This function is part of the KWS Interface.


This interface is not available for general access at this time. Fetch a permission for a given by index for a given local user

Return Value

  • EOS_Success if the permission state is known for the given user and index

  • EOS_NotFound if the user is not found or the index is invalid

See Also

EOS_KWS_CreateUser, EOS_KWS_QueryPermissions, EOS_KWS_RequestPermissions, EOS_KWS_PermissionStatus_Release



Parameter Type And NameUsage Information
const EOS_KWS_CopyPermissionByIndexOptions* OptionsStructure containing the input parameters
EOS_KWS_PermissionStatus** OutPermissionthe permission for the given index, if it exists and is valid, use EOS_KWS_PermissionStatus_Release when finished

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.