SAP ABAP Class CL_BNK_FILE_COMMUNICATION (File communication)

Hierarchy

☛ SAP_FIN (Software Component) SAP_FIN
   ⤷ FIN-FSCM (Application Component) Financial Supply Chain Management
     ⤷ FIN_BNK_COM_CORE (Package) Bank Communication: Core Objects

Properties

Class	CL_BNK_FILE_COMMUNICATION
Short Description	File communication
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	FIN_BNK_COM_CORE	Bank Communication: Core Objects
Created	20121107	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_BNK_FILE_COMMUNICATION has no forward declaration.

Interfaces

Class CL_BNK_FILE_COMMUNICATION has no interface implemented.

Friends

Class CL_BNK_FILE_COMMUNICATION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GV_BALNREXT	Constant	Public	☐	Type reference (TYPE)	BALNREXT	'Application Log PAIN002'	Application Log: External ID	20121126
2	GV_BAL_LOG	Static Attribute	Public	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20121107
3	GV_LINEFEED	Static Attribute	Private	☐	Type reference (TYPE)	XSTRING		Line Feed Type	20121107
4	GV_LOG_HANDLE	Static Attribute	Public	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20121107

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Static method	Public	Method	Add Message to Log	20121107
2	APPL_LOG	Static method	Public	Method	Log	20121107
3	DELETE_FILE	Static method	Public	Method	Delete file	20121107
4	DETERMINE_CODE_PAGE	Static method	Private	Method	Determine Code Page	20121107
5	DETERMINE_FULL_FILENAME	Static method	Private	Method	Determine Complete File Name Including Path	20121107
6	READ_FILE	Static method	Public	Method	Read File	20121107
7	SYS_DELETE_FILE	Static method	Private	Method	Delete File (Encapsulation of the DATASET Commands)	20121107
8	SYS_READ_FILE	Static method	Private	Method	Read File (Encapsulation of the DATASET Commands)	20121107
9	SYS_WRITE_FILE	Static method	Private	Method	Write File (Encapsulation of the DATASET Commands)	20121107
10	WRITE_FILE	Static method	Public	Method	Write File	20121107

Events

Class CL_BNK_FILE_COMMUNICATION has no event.

Types

Class CL_BNK_FILE_COMMUNICATION has no local type.

Method Signatures

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20121107
2	Importing	I_GUID	Call by reference	☑	Type reference (TYPE)	GUID_16		GUID in 'RAW' format	20121107

Method ADD_MESSAGE on class CL_BNK_FILE_COMMUNICATION has no exception.

Method APPL_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RETURN	Call by reference	☑	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20121107
2	Importing	I_PROBCLASS	Call by reference	☑	Type reference (TYPE)	BAL_S_MSG-PROBCLASS		Application log: Message problem class	20121107

Method APPL_LOG on class CL_BNK_FILE_COMMUNICATION has no exception.

Method DELETE_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		File Name with Expanded Placeholders (Without Directory)	20121107
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Logical Path Name	20121107

#	Exception	Resumable	Description	Created on
1	FILE_DELETE_ERROR	☐	Could not delete file	20121107

Method DETERMINE_CODE_PAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_CODE_PAGE	Value transfer	☐	Type reference (TYPE)	CPCODEPAGE		Code Page	20121107
2	Importing	IV_CODE_PAGE_CUST	Call by reference	☐	Type reference (TYPE)	CPCODEPAGE		Code Page	20121107

Method DETERMINE_CODE_PAGE on class CL_BNK_FILE_COMMUNICATION has no exception.

Method DETERMINE_FULL_FILENAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20121107
2	Exporting	EV_FULL_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Complete File Name (Including Directory)	20121107
3	Importing	IV_DIR	Call by reference	☐	Type reference (TYPE)	STRING		Physical Directory	20121107
4	Importing	IV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		File Name with Expanded Placeholders	20121107

#	Exception	Resumable	Description	Created on
1	FULL_FILENAME_NOT_DETERMINED	☐	Complete file name could not be determined	20121107

Method READ_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20121107
2	Exporting	ET_CONTENT	Call by reference	☐	Type reference (TYPE)	THCS_STRING		File Content	20121107
3	Importing	IV_CODE_PAGE	Call by reference	☐	Type reference (TYPE)	CPCODEPAGE		Code Page	20121107
4	Importing	IV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		File Name with Expanded Placeholders (Without Directory)	20121107
5	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Logical Path	20121107

#	Exception	Resumable	Description	Created on
1	FILE_READ_ERROR	☐	Error when Reading a File	20121107

Method SYS_DELETE_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OS_ERROR_MSG	Call by reference	☐	Type reference (TYPE)	SYMSGV		Error Message of Operating System	20121107
2	Importing	IV_DIR_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Complete File Name Including Directory	20121107

#	Exception	Resumable	Description	Created on
1	AUTHORITY_ERROR	☐	No authorization to delete the file	20121107
2	SYS_FILE_DELETE_ERROR	☐	The file could not be deleted	20121107

Method SYS_READ_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONTENT	Call by reference	☐	Type reference (TYPE)	THCS_STRING		File Content	20121107
2	Exporting	EV_OS_ERROR_MSG	Call by reference	☐	Type reference (TYPE)	SYMSGV		Error Message of Operating System	20121107
3	Importing	IV_CODE_PAGE	Call by reference	☐	Type reference (TYPE)	CPCODEPAGE		Code Page	20121107
4	Importing	IV_DIR_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Complete File Name Including Directory	20121107

#	Exception	Resumable	Description	Created on
1	AUTHORITY_ERROR	☐	No authorization to delete the file	20121107
2	CODEPAGE_ERROR	☐	Problem with the Code Page	20121107
3	SYS_FILE_READ_ERROR	☐	The file could not be deleted	20121107

Method SYS_WRITE_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_OS_ERROR_MSG	Call by reference	☐	Type reference (TYPE)	SYMSGV		Error Message of Operating System	20121107
2	Importing	IT_CONTENT	Call by reference	☐	Type reference (TYPE)	THCS_STRING		File Content	20121107
3	Importing	IV_CODE_PAGE	Call by reference	☐	Type reference (TYPE)	CPCODEPAGE		Code Page	20121107
4	Importing	IV_DIR_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Complete File Name Including Directory	20121107
5	Importing	IV_LINEFEED	Call by reference	☐	Type reference (TYPE)	XSTRING		Type of Line Break	20121107
6	Importing	IV_UPD_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		Overwrite or Append	20121107

#	Exception	Resumable	Description	Created on
1	AUTHORITY_ERROR	☐	No authorization to delete the file	20121107
2	CODEPAGE_ERROR	☐	Problem with the Code Page	20121107
3	SYS_FILE_WRITE_ERROR	☐	File could not be written	20121107

Method WRITE_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return parameter table	20121107
2	Importing	IT_CONTENT	Call by reference	☐	Type reference (TYPE)	THCS_STRING		File Content	20121107
3	Importing	IV_CODE_PAGE	Call by reference	☐	Type reference (TYPE)	CPCODEPAGE		Code Page	20121107
4	Importing	IV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Original File Name	20121107
5	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Logical Path	20121107

#	Exception	Resumable	Description	Created on
1	FILE_WRITE_ERROR	☐	Error when writing file	20121107

History

Last changed by/on	SAP	20131127
SAP Release Created in	617