Kernel 8.0 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

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

Reference Type: Supported, Category: Security Keys, Integration Agreement: 3277

Description

This 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:

The DUZ variable should be defined before calling this API.

(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.

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

 


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.