SET^XUS1A(): Output Message During Signon

Reference Type: Supported, Category: Signon/Security, Integration Agreement: 3057

Description

This API is used to perform any output during a software application-specific actions executed at signon. This function should only be used by action-type options attached to and executed by Kernel's XU USER SIGN-ON extended action.

Display of the string is not immediate; instead, every call to SET^XUS1A appends a node to an array containing the post signon text. When all software application-specific signon actions have completed, the signon process then displays the post signon text array, which will also contain any strings registered with the SET^XUS1A function, appended at the end.

Format

  SET^XUS1A(string)

Input Parameters

Output

Details

As of Kernel V. 8.0, software applications can attach an action-type option to a Kernel extended action-type option called XU USER SIGN-ON. This option, and all attached action-types, are executed during every signon.

NOTE: For more information on software application-specific action executed at signon, please refer to the "XU USER SIGN-ON: Package-specific Signon Actions" topic in the Kernel Programmer Manual.

Example