SAP ABAP Class CL_VSCAN_PARAMETER_SET (Record of Configuration Parameters)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SEC-VIR (Application Component) Anti-Virus Protection
⤷
SVSCAN (Package) Virus Scan of SAP Objects
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SEC-VIR (Application Component) Anti-Virus Protection⤷
SVSCAN (Package) Virus Scan of SAP ObjectsProperties
| Class | CL_VSCAN_PARAMETER_SET | |
| Short Description | Record of Configuration Parameters | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | VSCAN | |
| Program status | P | SAP Standard Production Program |
| Category | 0 | |
| Package | SVSCAN | Virus Scan of SAP Objects |
| Created | 20030807 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_VSCAN_PARAMETER_SET has no interface implemented.
Friends
Class CL_VSCAN_PARAMETER_SET has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CON_MAX_INT |
Constant | Private | Type reference (TYPE) | DEC20 | 2147483647 | Maximum Value for INT | 20041214 | |
| 2 | CON_MAX_LONG |
Constant | Private | Type reference (TYPE) | DEC20 | 9223372036854775807 | Maximum Value for LONG | 20041214 | |
| 3 | CON_MAX_SHORT |
Constant | Private | Type reference (TYPE) | DEC20 | 32767 | Maximum Value for SHORT | 20041214 | |
| 4 | CON_MIN_INT |
Constant | Private | Type reference (TYPE) | DEC20 | -2147483647 | Minimum Value for INT | 20041214 | |
| 5 | CON_MIN_LONG |
Constant | Private | Type reference (TYPE) | DEC20 | -9223372036854775807 | Minimum Value for LONG | 20041214 | |
| 6 | CON_MIN_SHORT |
Constant | Private | Type reference (TYPE) | DEC20 | -32767 | Minimum Value for SHORT | 20041214 | |
| 7 | CON_TYPE_BOOL |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'BOOL' | Boolean Value (0..1) | 20030807 | |
| 8 | CON_TYPE_BYTE |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'BYTE' | Native Character (0...255) | 20041214 | |
| 9 | CON_TYPE_CHAR |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'CHAR' | Character String | 20041214 | |
| 10 | CON_TYPE_DOUBLE |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'DOUBLE' | Floating Point Value (8 Bytes in Size) | 20041214 | |
| 11 | CON_TYPE_FLOAT |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'FLOAT' | Floating Point Value (4 Bytes in Size) | 20041214 | |
| 12 | CON_TYPE_INT |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'INT' | Numerical Value (-2147483647...2147483647) | 20041214 | |
| 13 | CON_TYPE_LONG |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'LONG' | Numerical Value (-9223372036854775807-9223372036854775807) | 20041214 | |
| 14 | CON_TYPE_OBJECT |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'OBJECT' | Not specified | 20041214 | |
| 15 | CON_TYPE_SHORT |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'SHORT' | Numerical Value (-32767...32767) | 20041214 | |
| 16 | CON_TYPE_SIZE_T |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'SIZE_T' | Size in Bytes (Platform-Dependent) | 20030807 | |
| 17 | CON_TYPE_TIME_T |
Constant | Public | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | 'TIME_T' | Timeframe in Seconds (Platform-Dependent) | 20030807 | |
| 18 | GF_FALLBACK_SET |
Instance attribute | Private | Object reference (TYPE REF TO) | CL_VSCAN_PARAMETER_SET | Fallback Set | 20030807 | ||
| 19 | GT_PARAMETER_INFO |
Static Attribute | Private | See coding | Mirror VSCAN_PARAM | 20030814 | |||
| 20 | GT_PARAMETER_TABLE |
Instance attribute | Private | See coding | Sorted Table with Parameters | 20030828 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_VALUE |
Static method | Public | Method | Check a Configuration Parameter for Permissibility | 20030807 |
| 2 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | Class Constructor | 20030814 |
| 3 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20030807 |
| 4 | GET |
Instance method | Public | Method | Read a Configuration Parameter | 20030807 |
| 5 | GET_PARAMETERS |
Instance method | Public | Method | Returns Table with Parameters/Values | 20030828 |
| 6 | GET_PARAMETER_TYPE |
Static method | Public | Method | Returns Parameter Type | 20030814 |
| 7 | IS_CUST_PARAMETER |
Static method | Public | Method | Test for Customizing Parameters | 20041221 |
| 8 | IS_INIT_PARAMETER |
Static method | Public | Method | Test for Initialization Parameters | 20030814 |
| 9 | IS_SCAN_PARAMETER |
Static method | Public | Method | Test for scan parameters | 20120124 |
| 10 | SET |
Instance method | Public | Method | Set a Configuration Parameter | 20030807 |
Events
Class CL_VSCAN_PARAMETER_SET has no event.
Types
Class CL_VSCAN_PARAMETER_SET has no local type.
Method Signatures
Method CHECK_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IF_ALLOW_CUST | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Prüfe im Kontext von Customizingparametern | 20041221 | |
| 2 | Importing |
IF_ALLOW_INIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Prüfe im Kontext von Initialisierungsparametern | 20030902 | |
| 3 | Importing |
IF_ALLOW_SCAN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Prüfe im Kontext von Scan-Parametern | 20030902 | |
| 4 | Importing |
IF_KEY | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_KEY | Schlüssel | 20030807 | ||
| 5 | Importing |
IF_VALUE | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_VALUE | Wert | 20030807 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CONTEXT_NOT_PERMITTED |
In diesem Kontext nicht zugelassen | 20030902 | |
| 2 | WRONG_KEY |
Schlüssel existiert nicht | 20030807 | |
| 3 | WRONG_VALUE_SYNTAX |
Falsche Syntax für Wert | 20030807 |
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_VSCAN_PARAMETER_SET has no parameter.
Method CLASS_CONSTRUCTOR on class CL_VSCAN_PARAMETER_SET has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IF_FALLBACK_SET | Call by reference | Object reference (TYPE REF TO) | CL_VSCAN_PARAMETER_SET | Parameter Set für Fallback Werte | 20030807 |
Method CONSTRUCTOR on class CL_VSCAN_PARAMETER_SET has no exception.
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
EF_VALUE | Value transfer | Type reference (TYPE) | VSCAN_PARAMETER_VALUE | Wert des Konfigurationsparameters | 20030807 | ||
| 2 | Importing |
IF_KEY | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_KEY | Schlüssel des Konfigurationsparameters | 20030807 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | WRONG_KEY |
Kein Eintrag mit diesem Schlüssel vorhanden | 20030807 |
Method GET_PARAMETERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_PARAMETER | Call by reference | Type reference (TYPE) | VSCAN_PARAM_T | Tabelle mit Parametern/Werten | 20030828 | ||
| 2 | Importing |
IF_CUST_PARAMETER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Liefere Customizingparameter | 20041221 | |
| 3 | Importing |
IF_INIT_PARAMETER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Liefere Initialisierungsparameter | 20030828 | |
| 4 | Importing |
IF_SCAN_PARAMETER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Liefere Scanparameter | 20030828 |
Method GET_PARAMETERS on class CL_VSCAN_PARAMETER_SET has no exception.
Method GET_PARAMETER_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EF_PARAMETER_TYPE | Value transfer | Type reference (TYPE) | VSCAN_PARAMETER_TYPE | Parametertyp | 20030814 | ||
| 2 | Importing |
IF_KEY | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_KEY | Parameterschlüssel | 20030814 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CONFIGURATION_ERROR |
Fehler in der Konfiguration | 20030814 |
Method IS_CUST_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EF_IS_CUST_PARAMETER | Value transfer | Type reference (TYPE) | ABAP_BOOL | Parameter ist Customizingparameter | 20041221 | ||
| 2 | Importing |
IF_KEY | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_KEY | Schlüssel eines Konfigurationsparameters | 20041221 |
Method IS_CUST_PARAMETER on class CL_VSCAN_PARAMETER_SET has no exception.
Method IS_INIT_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EF_IS_INIT_PARAMETER | Value transfer | Type reference (TYPE) | ABAP_BOOL | Parameter ist Initialisierungsparameter | 20030814 | ||
| 2 | Importing |
IF_KEY | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_KEY | Parameterschlüssel | 20030814 |
Method IS_INIT_PARAMETER on class CL_VSCAN_PARAMETER_SET has no exception.
Method IS_SCAN_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EF_IS_SCAN_PARAMETER | Value transfer | Type reference (TYPE) | ABAP_BOOL | Parameter ist Scanparameter | 20120124 | ||
| 2 | Importing |
IF_KEY | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_KEY | Schlüssel eines Konfigurationsparameters | 20120124 |
Method IS_SCAN_PARAMETER on class CL_VSCAN_PARAMETER_SET has no exception.
Method SET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IF_ALLOW_CUST | Call by reference | Type reference (TYPE) | ABAP_BOOL | ' ' | Setze im Kontext, wo Customizingparameter erlaubt | 20041221 | |
| 2 | Importing |
IF_ALLOW_INIT | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' | Setze im Kontext, wo Initialisierungsparameter erlaubt | 20030902 | |
| 3 | Importing |
IF_ALLOW_SCAN | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' | Setze im Kontext, wo Scan-Parameter erlaubt | 20030902 | |
| 4 | Importing |
IF_KEY | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_KEY | Schlüssel des Parameters | 20030807 | ||
| 5 | Importing |
IF_VALUE | Call by reference | Type reference (TYPE) | VSCAN_PARAMETER_VALUE | Wert des Konfigurationsparameters | 20030807 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | WRONG_KEY |
20030807 | ||
| 2 | WRONG_VALUE_SYNTAX |
Wert passt nicht zum vorgegebenen Typ | 20030807 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 640 |
