Contains FACE::Configuration_injectable documentation. More...

Data Structures
class	FACE::Configuration_Injectable::Injectable
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Description of the class More...

Functions
virtual void	FACE::Configuration_Injectable::Injectable::Set_Reference (const STRING_TYPE &interface_name, Configuration **interface_reference, const GUID_TYPE id, RETURN_CODE_TYPE::Value &return_code)=0
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Set_Reference function assigns an instance of an interface provider specified by interface_reference.

Detailed Description

Contains FACE::Configuration_injectable documentation.

Function Documentation

virtual void FACE::Configuration_Injectable::Injectable::Set_Reference	(	const STRING_TYPE &	interface_name,
		Configuration **	interface_reference,
		const GUID_TYPE	id,
		RETURN_CODE_TYPE::Value &	return_code
	)

pure virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The Set_Reference function assigns an instance of an interface provider specified by interface_reference.

Parameters:

[in]	interface_name	a human-readable name for the instance of the interface being provided - supports configuration of different instances of interfaces used by a component
[in,out]	interface_reference	a reference to the specific interface appropriate for the UoC
[in]	id	a UUID; to delineate the interface associated with a specific data modeled message or provide computer readable ID for an interface instance
[out]	return_code	upon return, contains a status code indicating success or failure

Returns:: NO_ERROR is returned in return_code to indicate the operation was successful.; INVALID_PARAM is returned in return_code to indicate the reference_interface parameter supplied is null or not in range.; NO_ACTION is returned in return_code to indicate the reference is a duplicate to one already set.; INVALID_MODE is returned in return_code to indicate a Set_Reference call was received while in steady state.; INVALID_CONFIG is returned in return_code to indicate a new reference is being set that has one or more parameters that creates an invalid request, such as a new name is provided for a reference that was previously provided.; NOT_AVAILABLE is returned in return_code to indicate the calling function cannot set more than one reference of this interface type for this UoC