EOS_KWS_GetPermissionByKey

EOS API reference page for EOS_KWS_GetPermissionByKey

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. Fetch the state of a given permission that are cached for a given local user.

Return Value

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

  • EOS_NotFound if the user or the permission is not found

See Also

EOS_KWS_CreateUser, EOS_KWS_QueryPermissions, EOS_KWS_RequestPermissions

Parameters

EOS_KWS_GetPermissionByKey

Parameter Type And Name

Usage Information

EOS_HKWS Handle

const EOS_KWS_GetPermissionByKeyOptions* Options

Structure containing the input parameters

EOS_EKWSPermissionStatus* OutPermission

the permission for the given key, if it exists and is valid

Related API Members

This function is part of the KWS Interface.

Remarks

This interface is not available for general access at this time. Fetch the state of a given permission that are cached for a given local user. {Result.NotFound} if the user or the permission is not found

Return Value

{Result.Success} if the permission state is known for the given user and key

See Also

{CreateUser}, {QueryPermissions}, {RequestPermissions}

Parameters

KWS.KWSInterface.GetPermissionByKey

Parameter Type And Name

Usage Information

GetPermissionByKeyOptions options

Structure containing the input parameters

KWSPermissionStatus outPermission

the permission for the given key, if it exists and is valid

Related API Members