str-var = Get_Label$(line-ptr)
|
Operands:
|
line-ptr
|
The line pointer of the data line whose Label/Handle is to be obtained.
|
Returns:
|
|
If the line-ptr argument is a valid line pointer to a data line, the function will return the label or handle associated with that data line. If neither exists; it will return a null (empty) string; the RC value will be set to 0 when the line-ptr is associated with a data line.
If both a User created label and a Request_Label$ created handle exist, the User created label is returned. The string value of the returned label will be just as it appears in the edit session, with a leading . dot and one to five letters in upper case.
If no User created label exists, but a Request_Label$ created handle exists, the Handle is returned. The string value will consist of a . dot plus an underscore and 'n' digits. e.g. ._123
If line-ptr is an invalid line pointer value, or is the line pointer of a non-data line, the function will return a null (empty) string and set RC to 8.
|
Created with the Personal Edition of HelpNDoc: Free help authoring environment