Previous Page Contents Page Next Page

4.8 Copy Presentation Space

The Copy Presentation Space function copies the entire contents of the presentation space to a string in your application program. Copied characters are translated into ASCII values before being stored in the data string.

4.8.1 Prior Functions

Your application program must be connected to a valid presentation space before issuing the request for this function. Use Connect Presentation Space to connect to a presentation space.

4.8.2 Request Parameters

Your application program must pass the following parameters to this function:

func_number

5 HA_COPY_PS

data_string

An empty data string defined in your application program. This string must be large enough to hold all of the information in the current presentation space. Presentation Space Sizes, shows the PS sizes for each of the display models.

If the option is set in Set Session Parameters , the string must be at least twice the PS size to allow for the EAB characters.

data_length

This parameter is not used.

ps_position

This parameter is not used.

4.8.3 Returned Parameters

This function returns the following parameters to your application program:

func_number

5

data_string

Contents of the current presentation space.

data_length

This parameter is not used.

return_code

The valid return codes for this function are:

HARC_SUCCESS

Function was successful; presentation space is active, keyboard is unlocked, and contents of host presentation space were copied to your application program.

HARC_NO_CONNECTION

Application program is not connected to a valid presentation space.

HARC_BUSY

Copy was successful, but presentation space is waiting for host response.

HARC_LOCKED

Copy was successful, but keyboard is locked.

HARC_SYSTEM_ERROR

System error occurred.

4.8.4 Affected by Set Session Parameters?

This function is affected by the following options of the Set Session Parameters function:

Causes field attribute bytes to be included unchanged in the returned string.

Causes field attribute bytes to be returned as blanks.

Copies each character from the presentation space followed by its extended attribute byte.

Does not copy attribute bytes.

If the option is set, causes the copied extended attribute bytes to be translated into CGA format.

If the option is set, causes extended attribute bytes to be copied without translation.

For more information, see Set Session Parameters.

4.8.5 Usage and Restrictions

Usage and restrictions are:

Previous Page Contents Page Top of Page Next page