Previous Topic Next topic Print topic


MF_CLIENT_STATE_RESTORE

Restores a previously saved or allocated record which matches the client identifier.

Note: This routine is supported for native COBOL only.

Syntax:

call "MF_CLIENT_STATE_RESTORE " using client-id
                                      client-state
                                      client-length
                                      server-status

Parameters:

  Using call prototype (see Key) Picture (32-bit systems)
client-id pic x(n). pic x(30).
client-state cblt-x4-compx pic x(4) comp-x.
client-length See Comments.
server-status cblt-x1-compx pic x comp-x.

On Entry:

client-id The client identifier.
client-state The state information to be saved. See Comments.
client-length The length of the empty record for the state information.

On Exit:

client-state The state information to be saved. See Comments.
server-status The status of the operation. See State Maintenance Routines Status.

Comments:

On entry, client-length is the length of the buffer. On exit, client-length returns the length of the data recovered. The data is truncated to fit the client-length specified on entry.

You can define any format for client-state records. Define the length of the client-state record in the client-length field.

Example:

 working-storage section. 
 ...
 01 client-id                pic x(30).
 01 client-length            pic xxxx comp-x.
 01 state-status             pic x comp-x.
01 client-state.
   03 user-preferences       pic x(10).
   03 user-selection-list    pic x(80).
...
 procedure division. 
 ...
     call "MF_CLIENT_STATE_RESTORE"
            using client-id client-state 
                  client-length state-status
 ...
Previous Topic Next topic Print topic