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

SET^XWBSEC(): Set the State Variable

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

Description

The SET^XWBSEC API sets the XWBSTATE environment variable (array) to contain a passed in value. This is generally used to record the current status of a Broker connection for monitoring or testing.

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

Format

  SET^XWBSEC(%,value)

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

value:

(required) This is FREE TEXT state value to be added to the XWBSTATE array.

Output Variables

%:

Returns this variable equal to the value input parameter and also sets the XWBSTATE(%) environment variable equal to the value input parameter.