EOS API reference page for EOS_KWS_QueryPermissions

3 mins to read

This function is part of the KWS Interface.


This interface is not available for general access at this time. Query the current state of permissions for a given local Product User ID

Return Value

  • EOS_Success if the account query completes successfully

  • EOS_InvalidParameters if any of the options are incorrect

  • EOS_TooManyRequests if the number of allowed requests is exceeded



Parameter Type And NameUsage Information
const EOS_KWS_QueryPermissionsOptions* Optionsoptions required for querying permissions such as the local users Product User ID
void* ClientDataArbitrary data that is passed back to you in the CompletionDelegate
const EOS_KWS_OnQueryPermissionsCallback CompletionDelegateA callback that is fired when the operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_KWS_OnQueryPermissionsCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_KWS_QueryPermissions

Callback Parameters


Parameter Type And NameUsage Information
const EOS_KWS_QueryPermissionsCallbackInfo* DataA EOS_KWS_QueryPermissionsCallbackInfo containing the output information and result