RPC Broker 1.1 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

CHKPRMIT^XWBSEC(): Check Permissions

Reference Type: Controlled Subscription, Category: Signon/Security, ICR#: 4053

Description

The CHKPRMIT^XWBSEC API checks to see if the remote procedure is permitted to run. It checks for:

If the user is an Application Proxy, it checks to see if Application Proxy access to the remote procedure is permitted.

Some remote procedures are allowed in any context:

All Kernel “XUS” and RPC Broker “XWB” remote procedures are allowed in “XUS SIGNON” context.

Format

  CHKPRMIT^XWBSEC(xwbrp)

Make sure to perform the following steps before calling this API:

  1. NEW all non-namespaced variables.

  2. Set all input variables.

  3. Call the API.

Input Parameters

xwbrp:

(required) This is the name of the remote procedure to look up in the REMOTE PROCEDURE (#8994) file.

Output Variables

XWBSEC:

Returns:

  • “”—Null in XWBSEC environment variable if the remote procedure is permitted to run.

  • Error Message—If the remote procedure is not permitted. If an error is returned, then the XWBSEC environment variable is set to return the same error message.

NOTE: XWBSEC is an environment variable, so that the information is included in the error trap should a subsequent processing error occur.