SAP ABAP Class CL_ABAP_FILE_UTILITIES (Utilities for Files)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
⤷
SABP (Package) ABAP Runtime Environment
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-ABA-LA (Application Component) Syntax, Compiler, Runtime⤷
SABP (Package) ABAP Runtime EnvironmentProperties
| Class | CL_ABAP_FILE_UTILITIES | |
| Short Description | Utilities for Files | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SABP | ABAP Runtime Environment |
| Created | 20040828 | SAP |
| Last change | 20090618 | 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_ABAP_FILE_UTILITIES has no interface implemented.
Friends
Class CL_ABAP_FILE_UTILITIES has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BOM_UTF16_BE |
Constant | Public | Type reference (TYPE) | SYCHAR01 | 'B' | UTF-16 Big Endian Byte-Order-Mark | 20040828 | |
| 2 | BOM_UTF16_LE |
Constant | Public | Type reference (TYPE) | SYCHAR01 | 'L' | UTF-16 Little Endian Byte-Order-Mark | 20040828 | |
| 3 | BOM_UTF8 |
Constant | Public | Type reference (TYPE) | SYCHAR01 | '8' | UTF-8 Byte-Order-Mark | 20040828 | |
| 4 | ENCODING_7BIT_ASCII |
Constant | Public | Type reference (TYPE) | SYCHAR01 | 'A' | 7-Bit ASCII | 20041221 | |
| 5 | ENCODING_OTHER |
Constant | Public | Type reference (TYPE) | SYCHAR01 | 'O' | Other Encoding | 20041221 | |
| 6 | ENCODING_UTF8 |
Constant | Public | Type reference (TYPE) | SYCHAR01 | 'U' | UTF-8 | 20041221 | |
| 7 | NO_BOM |
Constant | Public | Type reference (TYPE) | SYCHAR01 | ' ' | No Byte-Order-Mark | 20040828 | |
| 8 | TEST_7BIT |
Static Attribute | Private | Type reference (TYPE) | XSTRING | Internal Use Only | 20050117 | ||
| 9 | UTF8_CONV |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_ABAP_CONV_X2X_CE | Internal Use Only | 20050118 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_FOR_BOM |
Static method | Public | Method | Check for Byte-Order-Mark at Beginning of File | 20040828 |
| 2 | CHECK_STRING_7BIT_ASCII |
Static method | Public | Method | Check Whether a STRING Contains Only 7-Bit-ASCII | 20051216 |
| 3 | CHECK_UTF8 |
Static method | Public | Method | Check whether the file is UTF-8 | 20041221 |
| 4 | CHECK_XSTRING_UTF8 |
Static method | Public | Method | Check Whether an XSTRINF Is Encoded in UTF-8 | 20050627 |
| 5 | CONVERT_UTF8_BUF |
Static method | Private | Method | Internal Use Only | 20050118 |
| 6 | CREATE_UTF8_FILE_WITH_BOM |
Static method | Public | Method | Create a File with an UTF-8-Byte-Order-Mark at the Beginning | 20041119 |
| 7 | GET_CURRENT_NONUNI_CODEPAGE |
Static method | Public | Method | Get Non-Unicode Code Page For Current Language | 20080110 |
Events
Class CL_ABAP_FILE_UTILITIES has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | BOM_ID | Public | Type reference (TYPE) | SYCHAR01 | Not used | 20041123 | |
Method Signatures
Method CHECK_FOR_BOM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
FILE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Dateiname (wie bei OPEN DATASET) | 20040828 | ||
| 2 |  Returning |
RESULT | Value transfer | Type reference (TYPE) | SYCHAR01 | Eine Klassenkonstante, die die BOM angibt | 20040828 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SY_FILE_AUTHORITY |
System-Exceptions bei Dateizugriff | 20040828 | |
| 2 | CX_SY_FILE_IO |
System-Exceptions bei Dateizugriff | 20040828 | |
| 3 | CX_SY_FILE_OPEN |
System-Exceptions bei Dateizugriff | 20040828 |
Method CHECK_STRING_7BIT_ASCII Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
BAD_CHARS | Value transfer | Type reference (TYPE) | C | Zeichen außerhalb von 7-Bit-ASCII | 20051216 | ||
| 2 | Importing |
STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | String oder C-Feld | 20051216 |
Method CHECK_STRING_7BIT_ASCII on class CL_ABAP_FILE_UTILITIES has no exception.
Method CHECK_UTF8 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALL_IF_7BIT_ASCII | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Gesamte Datei lesen, falls 7-Bit-ASCII | 20041230 | |
| 2 | Exporting |
BOM | Call by reference | Type reference (TYPE) | SYCHAR01 | evtl. vorhandene Byte-Order-Mark (Klassenkonstante) | 20041221 | ||
| 3 | Exporting |
ENCODING | Call by reference | Type reference (TYPE) | SYCHAR01 | Encoding (Klassenkonstante) | 20041221 | ||
| 4 | Importing |
FILE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Dateiname (wie bei OPEN DATASET) | 20041221 | ||
| 5 | Importing |
MAX_KB | Call by reference | Type reference (TYPE) | NUMERIC | 8 | Obergrenze (Kilobyte) | 20041221 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SY_FILE_AUTHORITY |
System-Exceptions bei Dateizugriff | 20041221 | |
| 2 | CX_SY_FILE_IO |
System-Exceptions bei Dateizugriff | 20041221 | |
| 3 | CX_SY_FILE_OPEN |
System-Exceptions bei Dateizugriff | 20041221 |
Method CHECK_XSTRING_UTF8 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALL_IF_7BIT_ASCII | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Gesamte Datei lesen, falls 7-Bit-ASCII | 20050627 | |
| 2 | Exporting |
BOM | Call by reference | Type reference (TYPE) | SYCHAR01 | evtl. vorhandene Byte-Order-Mark (Klassenkonstante) | 20050627 | ||
| 3 | Exporting |
ENCODING | Call by reference | Type reference (TYPE) | SYCHAR01 | Encoding (Klassenkonstante) | 20050627 | ||
| 4 | Importing |
MAX_KB | Call by reference | Type reference (TYPE) | I | -1 | Obergrenze (Kilobyte) | 20050627 | |
| 5 | Exporting |
UTF8_BYTES_LEFT | Call by reference | Type reference (TYPE) | I | Länge eines eventuellen unvollständigen UTF-8-Zeichens | 20050627 | ||
| 6 | Importing |
XSTRING | Call by reference | Type reference (TYPE) | XSTRING | Zu testende Bytefolge | 20050627 |
Method CHECK_XSTRING_UTF8 on class CL_ABAP_FILE_UTILITIES has no exception.
Method CONVERT_UTF8_BUF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
ENCODING | Call by reference | Type reference (TYPE) | SYCHAR01 | Encoding (Klassenkonstante) | 20050118 | ||
| 2 | Importing |
XBUF | Call by reference | Type reference (TYPE) | X | Zu konvertierender Puffer | 20050118 | ||
| 3 | Changing |
XBUF_LEFT | Call by reference | Type reference (TYPE) | XSTRING | Rest, der nicht konvertiert werden konnte | 20050118 | ||
| 4 | Importing |
XBUF_LEN | Call by reference | Type reference (TYPE) | I | Länge von XBUF_LEN | 20050118 |
Method CONVERT_UTF8_BUF on class CL_ABAP_FILE_UTILITIES has no exception.
Method CREATE_UTF8_FILE_WITH_BOM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
FILE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Dateiname (wie bei OPEN DATASET) | 20041119 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SY_FILE_AUTHORITY |
System-Exceptions bei Dateizugriff | 20041119 | |
| 2 | CX_SY_FILE_CLOSE |
System-Exceptions bei Dateizugriff | 20041119 | |
| 3 | CX_SY_FILE_IO |
System-Exceptions bei Dateizugriff | 20041119 | |
| 4 | CX_SY_FILE_OPEN |
System-Exceptions bei Dateizugriff | 20041119 |
Method GET_CURRENT_NONUNI_CODEPAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CODEPAGE | Value transfer | Type reference (TYPE) | CPCODEPAGE | SAP-Zeichensatzidentifikation | 20080110 |
Method GET_CURRENT_NONUNI_CODEPAGE on class CL_ABAP_FILE_UTILITIES has no exception.
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in | 700 |
