SAP ABAP Interface IF_VSCAN_INSTANCE (Provider of Virus Scan Services)
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 Objects
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_VSCAN_ADAPTER | Virus Scan Adapter Class Object | 20070814 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_VSCAN_SERVER | Virus Scan Server | 20030817 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_VSI | Virus Scan API for Application Developers | 20030829 |
Properties
| Interface | IF_VSCAN_INSTANCE | |
| Short Description | Provider of Virus Scan Services |
General Data
| Package | SVSCAN | Virus Scan of SAP Objects |
| Created | 20030815 | SAP |
| Last changed | 20130531 | SAP |
| 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
Interface IF_VSCAN_INSTANCE has no interface.
Friends
Interface IF_VSCAN_INSTANCE has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CON_SCANRC_ACTIVECONTENT_FOUND | Constant | Public | Type reference (TYPE) | I | -3 | Active content in context where it is not permitted | 20120124 | |
| 2 | CON_SCANRC_BAD_EXPRESSION | Constant | Public | Type reference (TYPE) | I | 8 | Expression is invalid | 20070831 | |
| 3 | CON_SCANRC_BLOCKED_BY_POLICY | Constant | Public | Type reference (TYPE) | I | -6 | Content does not meet the defined rules | 20120124 | |
| 4 | CON_SCANRC_CBC_TERMINATED | Constant | Public | Type reference (TYPE) | I | 17 | Callback failed | 20070831 | |
| 5 | CON_SCANRC_CIO_FAILED | Constant | Public | Type reference (TYPE) | I | 12 | Client I/O failed | 20070831 | |
| 6 | CON_SCANRC_CLEAN_FAILED | Constant | Public | Type reference (TYPE) | I | -5 | Repair of at least one infection failed | 20030815 | |
| 7 | CON_SCANRC_CLEAN_OK | Constant | Public | Type reference (TYPE) | I | -1 | Repair of all infections/macros was successful | 20030815 | |
| 8 | CON_SCANRC_DRIVER_FAILED | Constant | Public | Type reference (TYPE) | I | 9 | Failed to load the driver | 20070831 | |
| 9 | CON_SCANRC_END_FAILED | Constant | Public | Type reference (TYPE) | I | 15 | Unloading of the scan engine was not successful | 20041201 | |
| 10 | CON_SCANRC_EXPIRED | Constant | Public | Type reference (TYPE) | I | 6 | Scan engine is obsolete (definition is vendor-dependent) | 20030815 | |
| 11 | CON_SCANRC_INVALID_HANDLE | Constant | Public | Type reference (TYPE) | I | 4 | Invalid pointer in VSA | 20070831 | |
| 12 | CON_SCANRC_INVALID_PARAM | Constant | Public | Type reference (TYPE) | I | 3 | Invalid parameter transferred | 20030815 | |
| 13 | CON_SCANRC_INVALID_SCANOBJECT | Constant | Public | Type reference (TYPE) | I | 11 | Invalid scan object specified | 20070831 | |
| 14 | CON_SCANRC_IN_PROGRESS | Constant | Public | Type reference (TYPE) | I | 16 | Cannot stop adapter | 20041201 | |
| 15 | CON_SCANRC_LOAD_FAILED | Constant | Public | Type reference (TYPE) | I | 7 | Loading the scan engine was not successful | 20041201 | |
| 16 | CON_SCANRC_MACRO_FOUND | Constant | Public | Type reference (TYPE) | I | -3 | At least one macro found | 20030815 | |
| 17 | CON_SCANRC_NOT_INITIALIZED | Constant | Public | Type reference (TYPE) | I | 5 | Adapter not initialized | 20041201 | |
| 18 | CON_SCANRC_NOT_SCANNED | Constant | Public | Type reference (TYPE) | I | 14 | At least one obj. not scanned(for example: due to extension) | 20030815 | |
| 19 | CON_SCANRC_NOT_SPACE | Constant | Public | Type reference (TYPE) | I | 1 | No memory free | 20041201 | |
| 20 | CON_SCANRC_NOT_SUPPORTED | Constant | Public | Type reference (TYPE) | I | 10 | Action/parameter not supported | 20030815 | |
| 21 | CON_SCANRC_NULL_PARAM | Constant | Public | Type reference (TYPE) | I | 2 | Empty parameter transferred | 20041201 | |
| 22 | CON_SCANRC_OK | Constant | Public | Type reference (TYPE) | I | 0 | No virus/macro found | 20030815 | |
| 23 | CON_SCANRC_PATTERN_FOUND | Constant | Public | Type reference (TYPE) | I | -4 | Rule violation found | 20040817 | |
| 24 | CON_SCANRC_SCAN_FAILED | Constant | Public | Type reference (TYPE) | I | 13 | Problem occurred during the scan (See detailed data) | 20030815 | |
| 25 | CON_SCANRC_VIRUS_FOUND | Constant | Public | Type reference (TYPE) | I | -2 | At least one virus found | 20030815 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | SCAN_BYTES |
Instance method | Public | Method | Scan a byte sequence | 20030817 |
| 2 | SCAN_FILE |
Instance method | Public | Method | Scanning of a Local (Application Server) File | 20040906 |
| 3 | SCAN_TEXT |
Instance method | Public | Method | Scan a text string | 20121030 |
Events
Interface IF_VSCAN_INSTANCE has no event.
Types
Interface IF_VSCAN_INSTANCE has no local type.
Method Signatures
Method SCAN_BYTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EF_DATA | Call by reference | Type reference (TYPE) | XSTRING | Nur bei IF_DO_CLEAN: Bereinigte Bytefolge | 20030830 | ||
| 2 | Exporting |
EF_SCANRC | Call by reference | Type reference (TYPE) | VSCAN_SCANRC | Scan-Ergebnis (CON_SCANRC_...) | 20030817 | ||
| 3 | Exporting |
ET_BAPIRET | Call by reference | Type reference (TYPE) | VSCAN_BAPIRET2_T | Tabelle mit Meldungen (auch ET_SCANERROR und ET_INFECTION) | 20030827 | ||
| 4 | Exporting |
ET_CONTENTINFO | Call by reference | Type reference (TYPE) | VSCAN_CONTENTINFO_T | Tabelle mit Scan-Inhaltsbeschreibungen | 20111012 | ||
| 5 | Exporting |
ET_INFECTION | Call by reference | Type reference (TYPE) | VSCAN_INFECTION_T | Tabelle mit gefundenen Viren (Details) | 20030827 | ||
| 6 | Exporting |
ET_SCANERROR | Call by reference | Type reference (TYPE) | VSCAN_SCANERROR_T | Tabelle mit Fehlern beim Scannen (Details) | 20030827 | ||
| 7 |  Importing |
IF_ACTIVE_CONTENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Activere Active Content Scan | 20070831 | |
| 8 | Importing |
IF_DATA | Call by reference | Type reference (TYPE) | XSTRING | Zu untersuchende Bytefolge | 20030817 | ||
| 9 | Importing |
IF_DO_CLEAN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Bytefolge bei Bedarf bereinigen | 20030830 | |
| 10 | Importing |
IF_JOB_ID | Call by reference | Type reference (TYPE) | VSCAN_JOB_ID | Job-IDdes Auftrages | 20030817 | ||
| 11 | Importing |
IF_MIME_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Ermittle den MIME Typ | 20120124 | |
| 12 | Importing |
IF_NO_DETAILS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Keine detaillierten Scandaten | 20070831 | |
| 13 | Importing |
IF_PATTERN_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Aktiviere den Pattern Scan | 20120124 | |
| 14 | Importing |
IT_SCAN_PARAMETER | Call by reference | Type reference (TYPE) | VSCAN_PARAM_T | Tabelle mit Scan-Parametern | 20030817 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CONFIGURATION_ERROR |
Fehler in der Konfiguration | 20030827 | |
| 2 | INTERNAL_ERROR |
Interner Fehler | 20030827 | |
| 3 | NOT_AVAILABLE |
Virus Scan Server temporär nicht verfügbar | 20030827 |
Method SCAN_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EF_SCANRC | Call by reference | Type reference (TYPE) | VSCAN_SCANRC | Scan-Ergebnis (CON_SCANRC_...) | 20040906 | ||
| 2 | Exporting |
ET_BAPIRET | Call by reference | Type reference (TYPE) | VSCAN_BAPIRET2_T | Tabelle mit Meldungen (auch ET_SCANERROR und ET_INFECTION) | 20040906 | ||
| 3 | Exporting |
ET_CONTENTINFO | Call by reference | Type reference (TYPE) | VSCAN_CONTENTINFO_T | Tabelle mit Scan-Inhaltsbeschreibungen | 20111012 | ||
| 4 | Exporting |
ET_INFECTION | Call by reference | Type reference (TYPE) | VSCAN_SCANERROR_T | Tabelle mit gefundenen Viren (Details) | 20040906 | ||
| 5 | Exporting |
ET_SCANERROR | Call by reference | Type reference (TYPE) | VSCAN_SCANERROR_T | Tabelle mit Fehlern beim Scannen (Details) | 20040906 | ||
| 6 | Importing |
IF_ACTIVE_CONTENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Activere Active Content Scan | 20070831 | |
| 7 | Importing |
IF_DO_CLEAN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Datei bei Bedarf bereinigen | 20040906 | |
| 8 | Importing |
IF_FILENAME | Call by reference | Type reference (TYPE) | STRING | Dateiname der lokal zu scannenden Datei | 20040906 | ||
| 9 | Importing |
IF_JOB_ID | Call by reference | Type reference (TYPE) | VSCAN_JOB_ID | Job-ID für einen Scanlauf | 20040906 | ||
| 10 | Importing |
IF_MIME_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Ermittle den MIME Typ | 20120124 | |
| 11 | Importing |
IF_NO_DETAILS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Keine detaillierten Scandaten | 20070831 | |
| 12 | Importing |
IF_PATTERN_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Aktiviere den Pattern Scan | 20120124 | |
| 13 | Importing |
IT_SCAN_PARAMETER | Call by reference | Type reference (TYPE) | VSCAN_PARAM_T | Tabelle mit Scan-Parametern | 20040906 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CONFIGURATION_ERROR |
Fehler in der Konfiguration | 20040906 | |
| 2 | DIFFERENT_HOSTS |
Virus Scan Server und Applikationsserver unterschiedlich | 20041201 | |
| 3 | INTERNAL_ERROR |
Interner Fehler | 20040906 | |
| 4 | NOT_AVAILABLE |
Virus Scan Server temporär nicht verfügbar | 20040906 |
Method SCAN_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EF_SCANRC | Call by reference | Type reference (TYPE) | VSCAN_SCANRC | Scan-Ergebnis (CON_SCANRC_...) | 20121030 | ||
| 2 | Exporting |
EF_TEXT | Call by reference | Type reference (TYPE) | XSTRING | Nur bei IF_DO_CLEAN: Bereinigte Bytefolge | 20121030 | ||
| 3 | Exporting |
ET_BAPIRET | Call by reference | Type reference (TYPE) | VSCAN_BAPIRET2_T | Tabelle mit Meldungen (auch ET_SCANERROR und ET_INFECTION) | 20121030 | ||
| 4 | Exporting |
ET_CONTENTINFO | Call by reference | Type reference (TYPE) | VSCAN_CONTENTINFO_T | Tabelle mit Scan-Inhaltsbeschreibungen | 20121030 | ||
| 5 | Exporting |
ET_INFECTION | Call by reference | Type reference (TYPE) | VSCAN_INFECTION_T | Tabelle mit gefundenen Viren (Details) | 20121030 | ||
| 6 | Exporting |
ET_SCANERROR | Call by reference | Type reference (TYPE) | VSCAN_SCANERROR_T | Tabelle mit Fehlern beim Scannen (Details) | 20121030 | ||
| 7 | Importing |
IF_ACTIVE_CONTENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Akiviere Aktive Content Scan | 20121030 | |
| 8 | Importing |
IF_DO_CLEAN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Textfolge bei Bedarf bereinigen | 20121030 | |
| 9 | Importing |
IF_JOB_ID | Call by reference | Type reference (TYPE) | VSCAN_JOB_ID | Job-IDdes Auftrages | 20121030 | ||
| 10 | Importing |
IF_MIME_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Ermittle den MIME Typ | 20121030 | |
| 11 | Importing |
IF_NO_DETAILS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Keine detaillierten Scandaten | 20121030 | |
| 12 | Importing |
IF_PATTERN_CHECK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Aktiviere den Pattern Scan | 20121030 | |
| 13 | Importing |
IF_TEXT | Call by reference | Type reference (TYPE) | STRING | Zu untersuchende Textfolge | 20121030 | ||
| 14 | Importing |
IT_SCAN_PARAMETER | Call by reference | Type reference (TYPE) | VSCAN_PARAM_T | Tabelle mit Scan-Parametern | 20121030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CONFIGURATION_ERROR |
Fehler in der Konfiguration | 20121030 | |
| 2 | INTERNAL_ERROR |
Interner Fehler | 20121030 | |
| 3 | NOT_AVAILABLE |
Virus Scan Server temporär nicht verfügbar | 20121030 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 640 |
