Hierarchy
⤷ CA-CL-CHR (Application Component) Characteristics
⤷ CT (Package) Characteristics
Basic Data
Data Element | ATPRF |
Short Description | Function Module for Checking Values |
Data Type
Category of Dictionary Type | D | Domain |
Type of Object Referenced | No Information | |
Domain / Name of Reference Type | ATPRF | |
Data Type | CHAR | Character String |
Length | 30 | |
Decimal Places | 0 | |
Output Length | 30 | |
Value Table |
Further Characteristics
Search Help: Name | ||
Search Help: Parameters | ||
Parameter ID | ||
Default Component name | CHECK_FUNCTION | |
Change document | ||
No Input History | ||
Basic direction is set to LTR | ||
No BIDI Filtering |
Field Label
Length | Field Label | |
Short | 10 | Function |
Medium | 15 | Function |
Long | 20 | Function Module |
Heading | 30 | Function Module |
Documentation
Definition
In this field, you can enter the name of a function module for checking characteristic values entered by the user. The function module can be created in any function group.
The following restrictions apply:
- The function module must use the standardized interface.
- The function module name cannot have more than 27 characters.
This allows names to be inferred for further function modules: for the possible entries on the value assignment screen, and for copying language-dependent value descriptions:
- Function module for possible entries
- <function module for value check> + suffix "_F4"
- Function module for language-dependent value descriptions
- <function module for value check> + suffix "_DC"
Interface for Function Module for Checking Values
Import Parameters:
CHARACT_NO LIKE CABN-ATINN Internal characteristic number
CHARACT LIKE CABN-ATNAM Characteristic name
VALUE LIKE CAWN-ATWRT Value to be checked
Exceptions:
NOT_FOUND Value not found
Interface for Function Module for Possible Entries
Import Parameters:
CHARACT_NO LIKE CABN-ATINN Internal characteristic number
CHARACT LIKE CABN-ATNAM Characteristic name
DISPLAY Display values only,
if DISPLAY = 'X'
ADDITIONAL_VALUES LIKE CABN-ATSON Additional values allowed
if ADDITIONAL_VALUES = 'X'
(if you want the possible
entries dialog box to contain an
additional line for entry)
MULTIPLE_VALUES LIKE RCTMV-ATLIS Multiple values allowed
LANGUAGE LIKE SY-LANGU Language indicator
DISPLAY_WITH_LANGUAGE Display value with description
Tables
VALUES LIKE RCTVALUES Selected values
When you call this table, it
contains existing values.
Deleted values have status 'D'
in the table.
New values have status 'I'
in the table.
The function module must also let you display and select values using the possible entries pushbutton. To display possible entries, you can use function modules in function group SHL3, such as HELP_VALUES_GET_WITH_TABLE_EXT. The content is described in the function module documentation.
Interface for Function Module for Language-Dependent Value Descriptions
Import parameters
CHARACT_NO LIKE CABN-ATINN Internal characteristic number
CHARACT LIKE CABN-ATNAM Characteristic name
VALUE LIKE CAWN-ATWRT Value to be checked
LANGUAGE LIKE SY-LANGU System language
Exceptions
NOT_FOUND Value not found
If you use this function module after the function module for checking values, the language-dependent description of the value is copied to the value assignment screen.
Note
Please note that the program code must be based on the predefined interfaces. If your program is not based on these interfaces, the program may terminate with a short dump.
Please note also that the function module cannot take into account any restrictions on allowed values that are due to inheritance or object dependencies, because the function can only read data that is already saved to database tables. The function cannot read current user entries.
History
Last changed by/on | SAP | 20020827 |
SAP Release Created in |