Metadata for function modules
[Metadata and Repository API]

---

Detailed Description

Functions for creating, reading and traversing through function module descriptions.

Functions
DECL_EXP RFC_FUNCTION_DESC_HANDLE SAP_API	RfcCreateFunctionDesc (SAP_UC const *name, RFC_ERROR_INFO *errorInfo)
	Creates an empty function description with the given name.
DECL_EXP RFC_RC SAP_API	RfcGetFunctionName (RFC_FUNCTION_DESC_HANDLE funcDesc, RFC_ABAP_NAME bufferForName, RFC_ERROR_INFO *errorInfo)
	Returns a function module's DDIC name.
DECL_EXP RFC_RC SAP_API	RfcAddParameter (RFC_FUNCTION_DESC_HANDLE funcDesc, const RFC_PARAMETER_DESC *paramDescr, RFC_ERROR_INFO *errorInfo)
	Adds a new parameter (IMPORTING, EXPORTING, CHANGING, TABLES) to the function description.
DECL_EXP RFC_RC SAP_API	RfcGetParameterCount (RFC_FUNCTION_DESC_HANDLE funcDesc, unsigned *count, RFC_ERROR_INFO *errorInfo)
	Returns the number of parameters in the function module definition.
DECL_EXP RFC_RC SAP_API	RfcGetParameterDescByIndex (RFC_FUNCTION_DESC_HANDLE funcDesc, unsigned index, RFC_PARAMETER_DESC *paramDesc, RFC_ERROR_INFO *errorInfo)
	Reads the metadata description of the function module's ith parameter.
DECL_EXP RFC_RC SAP_API	RfcGetParameterDescByName (RFC_FUNCTION_DESC_HANDLE funcDesc, SAP_UC const *name, RFC_PARAMETER_DESC *paramDesc, RFC_ERROR_INFO *errorInfo)
	Reads the metadata description of a function module parameter given by name.
DECL_EXP RFC_RC SAP_API	RfcAddException (RFC_FUNCTION_DESC_HANDLE funcDesc, const RFC_EXCEPTION_DESC *excDesc, RFC_ERROR_INFO *errorInfo)
	Adds a new ABAP Exception to the function description.
DECL_EXP RFC_RC SAP_API	RfcGetExceptionCount (RFC_FUNCTION_DESC_HANDLE funcDesc, unsigned *count, RFC_ERROR_INFO *errorInfo)
	Returns the number of ABAP Exceptions of the function module.
DECL_EXP RFC_RC SAP_API	RfcGetExceptionDescByIndex (RFC_FUNCTION_DESC_HANDLE funcDesc, unsigned index, RFC_EXCEPTION_DESC *excDesc, RFC_ERROR_INFO *errorInfo)
	Reads the metadata description of the function module's ith ABAP Exception.
DECL_EXP RFC_RC SAP_API	RfcGetExceptionDescByName (RFC_FUNCTION_DESC_HANDLE funcDesc, SAP_UC const *name, RFC_EXCEPTION_DESC *excDesc, RFC_ERROR_INFO *errorInfo)
	Reads the metadata description of a function module's ABAP Exception given by name.
DECL_EXP RFC_RC SAP_API	RfcEnableBASXML (RFC_FUNCTION_DESC_HANDLE funcDesc, RFC_ERROR_INFO *errorInfo)
	Enables this function module for the basXML serialization format.
DECL_EXP RFC_RC SAP_API	RfcIsBASXMLSupported (RFC_FUNCTION_DESC_HANDLE funcDesc, int *isEnabled, RFC_ERROR_INFO *errorInfo)
	Returns whether this function module has been enabled for basXML.
DECL_EXP RFC_RC SAP_API	RfcDestroyFunctionDesc (RFC_FUNCTION_DESC_HANDLE funcDesc, RFC_ERROR_INFO *errorInfo)
	Deletes the function description and releases the allocated resources.
DECL_EXP RFC_RC SAP_API	RfcEnableAbapClassException (RFC_FUNCTION_HANDLE funcHandle, RFC_CONNECTION_HANDLE rfcHandleRepository, RFC_ERROR_INFO *errorInfo)
	Enables this function handle for ABAP class exception support.
DECL_EXP RFC_RC SAP_API	RfcIsAbapClassExceptionEnabled (RFC_FUNCTION_HANDLE funcHandle, int *isEnabled, RFC_ERROR_INFO *errorInfo)
	Checks whether this function handle has been enabled for ABAP class exception support.

---

Function Documentation

DECL_EXP RFC_RC SAP_API RfcAddException	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		const RFC_EXCEPTION_DESC *	excDesc,
		RFC_ERROR_INFO *	errorInfo
	)

Adds a new ABAP Exception to the function description.

Note:

After the function description has been used via RfcCreateFunction() or RfcAddFunctionDesc(), it can no longer be modified!

Parameters:

[in]	funcDesc	The function module's metadata description.
[in]	*excDesc	The description of the exception to add.
[out]	*errorInfo	Not much that can go wrong here.

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcAddParameter	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		const RFC_PARAMETER_DESC *	paramDescr,
		RFC_ERROR_INFO *	errorInfo
	)

Adds a new parameter (IMPORTING, EXPORTING, CHANGING, TABLES) to the function description.

Note:

After the function description has been used via RfcCreateFunction() or RfcAddFunctionDesc(), it can no longer be modified!

Parameters:

[in]	funcDesc	The function module description.
[in]	*paramDescr	Metadata description of the new parameter.
[out]	*errorInfo	More details in case something goes wrong.

Returns:

RFC_RC

DECL_EXP RFC_FUNCTION_DESC_HANDLE SAP_API RfcCreateFunctionDesc	(	SAP_UC const *	name,
		RFC_ERROR_INFO *	errorInfo
	)

Creates an empty function description with the given name.

Add parameter descriptions and exception descriptions to the new RFC_FUNCTION_DESC_HANDLE via RfcAddParameter() and RfcAddException().

After the handle was used for creating a container, any modifications are forbidden.

Parameters:

[in]	*name	The name of the function module.
[out]	*errorInfo	Probably not enough memory left?!

Returns:

An empty function description that can be used for constructing hard-coded metadata.

DECL_EXP RFC_RC SAP_API RfcDestroyFunctionDesc	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		RFC_ERROR_INFO *	errorInfo
	)

Deletes the function description and releases the allocated resources.

Only descriptions, which are not stored in a repository cache and not used by the application, can be deleted. Deleting a cached description will cause an error, and deleting a description that is still in use, will lead to a crash.

Parameters:

[in]	funcDesc	A function description.
[out]	*errorInfo	Should always return successfully...

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcEnableAbapClassException	(	RFC_FUNCTION_HANDLE	funcHandle,
		RFC_CONNECTION_HANDLE	rfcHandleRepository,
		RFC_ERROR_INFO *	errorInfo
	)

Enables this function handle for ABAP class exception support.

R/3 Systems from kernel release 7.11 on support ABAP class exception. Calling RfcEnableAbapClassException() allows the RFC call invoked over this function handle to be able to support the ABAP class exception, if the target backend supports it.

Parameters:

[in]	funcHandle	function module data container .
[in]	rfcHandleRepository	RFC connection handle to the repository system from where the missing metadata can be dynamically retrieved during de-serializing the received ABAP class exceptions. This handle can be NULL but should not be the same that's used for the RFC call itself.
[out]	*errorInfo	Should always return successfully.

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcEnableBASXML	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		RFC_ERROR_INFO *	errorInfo
	)

Enables this function module for the basXML serialization format.

R/3 Systems from kernel release 7.10 on support a new serialization format: basXML (binary ABAP serialization). Calling RfcEnableBASXML() allows the RFC library to transport this function module's data via the basXML format, if the target backend supports it.

Parameters:

[in]	funcDesc	The function module's metadata description.
[out]	*errorInfo	Should always return successfully.

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcGetExceptionCount	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		unsigned *	count,
		RFC_ERROR_INFO *	errorInfo
	)

Returns the number of ABAP Exceptions of the function module.

Parameters:

[in]	funcDesc	The function module's metadata description.
[out]	*count	The number of the function module's ABAP Exceptions.
[out]	*errorInfo	Not much that can go wrong here.

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcGetExceptionDescByIndex	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		unsigned	index,
		RFC_EXCEPTION_DESC *	excDesc,
		RFC_ERROR_INFO *	errorInfo
	)

Reads the metadata description of the function module's ith ABAP Exception.

Parameters:

[in]	funcDesc	The function module's metadata description.
[in]	index	The index of the exception to describe.
[out]	*excDesc	The ABAP Exception's metadata description.
[out]	*errorInfo	Index out of bounds?

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcGetExceptionDescByName	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		SAP_UC const *	name,
		RFC_EXCEPTION_DESC *	excDesc,
		RFC_ERROR_INFO *	errorInfo
	)

Reads the metadata description of a function module's ABAP Exception given by name.

Parameters:

[in]	funcDesc	The function module's metadata description.
[in]	*name	The name of the exception to describe.
[out]	*excDesc	The ABAP Exception's metadata description.
[out]	*errorInfo	No such ABAP Exception?

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcGetFunctionName	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		RFC_ABAP_NAME	bufferForName,
		RFC_ERROR_INFO *	errorInfo
	)

Returns a function module's DDIC name.

Parameters:

[in]	funcDesc	The function module description.
[out]	bufferForName	Will receive the function module's DDIC name.
[out]	*errorInfo	Should always return successfully.

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcGetParameterCount	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		unsigned *	count,
		RFC_ERROR_INFO *	errorInfo
	)

Returns the number of parameters in the function module definition.

Parameters:

[in]	funcDesc	The function module's metadata description.
[out]	*count	The number of parameters (IMPORTING, EXPORTING, CHANGING, TABLES).
[out]	*errorInfo	Nothing can go wrong here.

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcGetParameterDescByIndex	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		unsigned	index,
		RFC_PARAMETER_DESC *	paramDesc,
		RFC_ERROR_INFO *	errorInfo
	)

Reads the metadata description of the function module's ith parameter.

Note:

Mostly be useful when looping over all parameters of a function module.

Parameters:

[in]	funcDesc	The function module's metadata description.
[in]	index	The index of the parameter to describe.
[out]	*paramDesc	Metadata description of the specified parameter.
[out]	*errorInfo	Index out of bounds?

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcGetParameterDescByName	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		SAP_UC const *	name,
		RFC_PARAMETER_DESC *	paramDesc,
		RFC_ERROR_INFO *	errorInfo
	)

Reads the metadata description of a function module parameter given by name.

Parameters:

[in]	funcDesc	The function module's metadata description.
[in]	*name	The name of the parameter to describe.
[out]	*paramDesc	Metadata description of the specified parameter.
[out]	*errorInfo	No such parameter?

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcIsAbapClassExceptionEnabled	(	RFC_FUNCTION_HANDLE	funcHandle,
		int *	isEnabled,
		RFC_ERROR_INFO *	errorInfo
	)

Checks whether this function handle has been enabled for ABAP class exception support.

R/3 Systems from kernel release 7.11 on support ABAP class exception. Typically, a RFC server uses function to is called by RFC server ll invoked over this function handle to be able to support the ABAP class exception, if the target backend supports it.

Parameters:

[in]	funcHandle	function module data container.
[out]	*isEnabled	flag indicates whether the function handle has been enabled for ABAP class based exception support
[out]	*errorInfo	Should always return successfully.

Returns:

RFC_RC

DECL_EXP RFC_RC SAP_API RfcIsBASXMLSupported	(	RFC_FUNCTION_DESC_HANDLE	funcDesc,
		int *	isEnabled,
		RFC_ERROR_INFO *	errorInfo
	)

Returns whether this function module has been enabled for basXML.

See RfcEnableBASXML()

Parameters:

[in]	funcDesc	The function module's metadata description.
[out]	*isEnabled	0 = false, 1 = true.
[out]	*errorInfo	Should always return successfully.

Returns:

RFC_RC