OVERRIDE_KEY_CAPTION_SCREEN Function

RAMP-NL

OVERRIDE_KEY_CAPTION_SCREEN Function


Assigns a new caption for a function key on a particular screen.

Syntax

OVERRIDE_KEY_CAPTION_SCREEN (sDestinationName,sKeyName,sOverrideCaption)

Parameters

sDestinationName

Required. A string that contains the name of a Destination.

sKeyName

Required. String that contains the name of the key. See Function Key Names for SENDKEY Function.

sOverrideCaption

Required. The new caption that will be used for the button

Return Value

None

Example

OVERRIDE_KEY_CAPTION_SCREEN("uDisplayEmployee", KeyF1, "Aide");

 

Notes

This function is very sensitive to where in a RAMP script it is used. If it is used in an INVOKE script for a destination, it should be placed just before the destination screen appears.

This function can also be used in a sign-on script.