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

DIVSET^XUSRB2(): Set Division for Current User

Reference Type: Controlled Subscription, Category: User, ICR#: 4055

Description

The DIVSET^XUSRB2 API sets the division for the current user.

(This was developed as a Broker Remote Procedure Call [RPC] and all RPCs have as the first parameter the return/output parameter.)

Format

  DIVSET^XUSRB2(ret,div)

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.
div:

(required) This is the division to select. If passed with a leading grave accent (`) an Internal Entry Number (IEN) is being passed and is processed as such.

Output Parameters

ret():

Returns a Boolean value in the subscripted output array:

  • True (non-zero)—Division selection is considered successful.

  • False (zero)—Division selection failed.