AVRESTOREAVALUE and AVRESTORENVALUE Function

RAMP-TS

AVRESTOREAVALUE and AVRESTORENVALUE Function

Restore an alphanumeric or numeric value from the VLF virtual clipboard.

Syntax

AVRESTOREAVALUE/AVRESTORENVALUE(Default, sID1, sID2, sID3, iInstance, sLanguage)

Parameters

Default

Required. String/Number that contains the default value to return if the value is not found . 

sID1

Required. String that contains the Virtual Clipboard identifier 1.

sID2

Optional. String that contains the Virtual Clipboard identifier 2.

sID3

Optional. String that contains the Virtual Clipboard identifier 3.

iInstance

Optional. Integer that contains the instance number. Defaults to 1 when not specified

sLanguage

Optional. String that contains the language code. Defaults to ALL languages when not specified.

 

  

Return Value

None

Remarks

Use AVRESTOREAVALUE/AVRESTORENVALUE in your RAMP scripts to restore a value from the VLF virtual clipboard. More information about the Virtual Clipboard can be found in The Virtual Clipboard in the Framework guide.

For information about the parameter lengths, please refer to VF_RESTOREAVALUE and VF_RESTORENVALUE in the Framework guide.

 

Examples 

var sSavedSurname = AVRESTOREAVALUE("Not Found", "NewEmployee", "Surname", "", 1, FRA);

var sSavedPostcode = AVRESTOREAVALUE(9999, "NewEmployee", "Postcode");