Kernel APIs: OWNSKEY^XUSRB

OWNSKEY^XUSRB(): Verify Security Keys Assigned to a User

Reference Type: Supported, Category: Security Keys, ICR#: 3277

Description

The OWNSKEY^XUSRB API is used by the XUS KEY CHECK RPC. This API can be used to verify if a user has a specified security key assigned. The calling routine sends one or a reference to a subscripted array and the API returns a subscripted array with the following possible values:

1—User owns key.
0—Key not found.

The DUZ variable should be defined before calling this API.

NOTE: This was developed as a Broker RPC and all RPCs have as the first parameter the return/output parameter.

Format

  OWNSKEY^XUSRB(ret,list[,ien])

Input Parameters

ret:	(required) Name of the subscripted return array. In every API that is used as an RPC, the first parameter is the return array.
list:	(required) A single value or a subscripted input array of security keys to be evaluated.
ien:	(optional) The DUZ of a user for whom you want to check if he/she holds security keys.

Output Parameter

ret():

Returns a subscripted output array of the input value/subscripted array (i.e. list) with the following possible values shown:

1—User owns key.
0—Key not found.

Examples

Example 1

In the following example, the return array is named ZZ and the single security key to be checked is the XUPROG security key:

>K ZZ D OWNSKEY^XUSRB(.ZZ,"XUPROG") ZW ZZ
ZZ(0)=1

Example 2

In the following example, the return array is named ZZ and the input array of security keys to be checked is named LST:

>K LST S LST(1)="XUPROG",LST(2)="XUMGR",LST(3)="ABC"
>K ZZ D OWNSKEY^XUSRB(.ZZ,.LST) ZW ZZ
ZZ(1)=1
ZZ(2)=1
ZZ(3)=0