$Screen_attr

Get screen attributes as blank-delimited string

This function returns the attributes of a screen item as a blank-delimited string. It can be useful for passing the attributes of a screen to another application, perhaps running on a different platform.

Syntax

%string = $Screen_attr(scr_item, [protected], [invisible], [tagged])

Syntax terms

%string	This string value contains a blank-separated list of attributes for the requested screen item.
scr_item	The screen item for which attributes are to be returned. This can be a variable of the form %screen:item or a screen item name variable of the form :%string.
protected	The word to be added to the result string if the screen item is protected. If protected is not specified, no word is added to the result string for protected screen items.
invisible	The word to be added to the result string if the screen item is invisible. If invisible is not specified, no word is added to the result string for invisible screen items.
tagged	The word to be added to the result string if the screen item is tagged. If tagged is not specified, no word is added to the result string for tagged screen items.

Example

This code fragment displays the attributes of screen item bar in screen foo:

print $Screen_attr(%foo:bar, "protected", "invisible", "tagged")