Progress
Language Reference


GET-STRING Function

Interfaces
OS
SpeedScript
All
All
Yes

Returns the null-terminated character string at the specified memory location as a CHARACTER value (not including the null terminator) or the number of bytes specified starting from the specified memory location as a CHARACTER value.

SYNTAX

GET-STRING ( source , position [ , numbytes ] ) 

source

A function or variable that returns a RAW or MEMPTR value. If source is the unknown value, GET-STRING returns the unknown value (?).

position

An integer value greater than 0 that indicates the byte position where you want to find the information. If position is greater than the length of source, Progress returns the unknown value (?). If position is less than 1, Progress generates a run-time error.

numbytes

An integer value greater than 0 that indicates how many bytes to convert into the CHARACTER value that is returned. If position plus numbytes is greater than the length of source, Progress returns the UNKNOWN value (?). If numbytes is not specified, or is -1, GET-STRING( ) returns all bytes until it encounters a NULL value.

EXAMPLES

For examples of how to use the GET-STRING function, see the GET-BYTE Function reference entry.

NOTES

SEE ALSO

LENGTH Function, PUT-STRING Statement, RAW Function (ORACLE only), RAW Statement (ORACLE only), SET-SIZE Statement


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095