GET-CLIENT-VALUE Action

#### Search Results

Search

# GET-CLIENT-VALUE Action

This document covers the following topics:

- Description

- Parameters

## Description

Retrieves user-defined information for a dialog or dialog element that has been set by the use of either the CLIENT-KEY and CLIENT-VALUE attributes, or the SET-CLIENT-VALUE action.

Unlike the use of the CLIENT-VALUE attribute, the retrieved data is moved (with MOVE -compatible conversion, if necessary) directly into the output field specified to retrieve the value, with no intermediate conversion to alpha being performed. If no value is found, the output field is implicitly RESET. In order to be able to differentiate between this case from the retrieval of an explicitly stored resetted value, an optional parameter may be supplied to return a flag indicating whether the specified key was found.

For more information, please refer to the article Storing and Retrieving Client Data for a Dialog Element.

## Parameters

Name/Data Type | Explanation
--- | ---
HANDLE OF GUI | Input Handle of dialog or dialog element for which the client information is to be retrieved.
Client value (any data type) | Output Specifies the field, into which the value that is stored under the specified key is to be retrieved (with conversion, if necessary). If the specified key was not found for the specified dialog or dialog element, the field is reset.
Client key (A253) | Input (optional parameter) If specified, this is the key, for which the specified value is to be retrieved.If this parameter is omitted, the key (if any) specified by the CLIENT-KEY attribute of the specified dialog or dialog element is implicitly used.If the key is empty (i.e., all blank), the request is ignored
Found (L) | Output (optional parameter) If specified, this parameter is set to TRUE if the specified key was found for the specified dialog or dialog element, or FALSE otherwise.
Response (I4) | Output Natural error (if applicable).

#### Example:

    DEFINE DATA LOCAL
    01 #TIME (T)
    01 #DATE (D)
    ...
    END-DEFINE
    *
    /* Get value for (explicit) 'TIME' key for dialog
    PROCESS GUI ACTION GET-CLIENT-VALUE WITH #DLG$WINDOW #TIME 'TIME'
      GIVING *ERROR

    /* Get value for (implicit) 'DATE' key for dialog
    #DLG$WINDOW.CLIENT-KEY := 'DATE'
    PROCESS GUI ACTION GET-CLIENT-VALUE WITH #DLG$WINDOW #DATE
      GIVING *ERROR

### On this page

- Description
- Parameters