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

CRCONTXT^XWBSEC(): Create Context

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

Description

The CRCONTXT^XWBSEC API creates a valid RPC Broker user context.

Format

  CRCONTXT^XWBSEC(result,option)

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

option:

(required) This is the name of the B-type menu option to look up in the OPTION (#19) file. If the option has been assigned to the user as a SECONDARY MENU OPTION, then the context can be set.

REF: For more information on context options, see the “RPC Security: How to Register an RPC” section in the RPC Broker Developer's Guide.

Output

result:

Returns:

  • 1—Successful: If the context is successfully created.

  • 0 (and error message)—Unsuccessful: If the context could not be created.

Output Variables

XWBSEC:

XWBSEC is an environment variable, so that the information is included in the error trap should a subsequent processing error occur. If an error is returned, then the XWBSEC environment variable is set to return the same error message.