EOS_KWS_QueryPermissions

EOS API reference page for EOS_KWS_QueryPermissions

Choose your implementation method:

C

C#

This function is part of the KWS Interface.

Remarks

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

Parameters

EOS_KWS_QueryPermissions

Parameter Type And Name

Usage Information

EOS_HKWS Handle

const EOS_KWS_QueryPermissionsOptions* Options

options required for querying permissions such as the local users Product User ID

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_KWS_OnQueryPermissionsCallback CompletionDelegate

A callback that is fired when the operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

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

EOS_KWS_OnQueryPermissionsCallback

Parameter Type And Name

Usage Information

const EOS_KWS_QueryPermissionsCallbackInfo* Data

A EOS_KWS_QueryPermissionsCallbackInfo containing the output information and result

Related API Members

This function is part of the KWS Interface.

Remarks

This interface is not available for general access at this time. Query the current state of permissions for a given local Product User ID {Result.InvalidParameters} if any of the options are incorrect {Result.TooManyRequests} if the number of allowed requests is exceeded

Return Value

{Result.Success} if the account query completes successfully

Parameters

KWS.KWSInterface.QueryPermissions

Parameter Type And Name

Usage Information

QueryPermissionsOptions options

options required for querying permissions such as the local users Product User ID

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnQueryPermissionsCallback completionDelegate

A callback that is fired when the operation completes, either successfully or in error

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

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

Callback Remarks

Function prototype definition for callbacks passed to {KWSInterface.QueryPermissions}

Callback Parameters

KWS.OnQueryPermissionsCallback

Parameter Type And Name

Usage Information

QueryPermissionsCallbackInfo data

A EOS_KWS_QueryPermissionsCallbackInfo containing the output information and result

Related API Members