sopc_encodeable.h File Reference

Deprecated and replacement is integrated into sopc_encodeabletype.h (Encodeable object services). More...

#include <stdint.h>
#include "sopc_builtintypes.h"
#include "sopc_encodeabletype.h"

Go to the source code of this file.

Functions
SOPC_ReturnStatus	SOPC_Encodeable_Create (SOPC_EncodeableType *encTyp, void **encObject)
	Instantiate and initialize an encodeable object of the given encodeable type.
SOPC_ReturnStatus	SOPC_Encodeable_Delete (SOPC_EncodeableType *encTyp, void **encObject)
	Clear and deallocate an encodeable object of the given encodeable type.
SOPC_ReturnStatus	SOPC_Encodeable_CreateExtension (SOPC_ExtensionObject *extObject, SOPC_EncodeableType *encTyp, void **encObject)
	Create an encodeable object of the given encodeable type and set it in the given extension object.
SOPC_ReturnStatus	SOPC_Encodeable_Move (void *destObj, void *srcObj)
	Moves content of srcObj to destObj, i.e. copy srcObj structure content to destObj and reset srcObj. Both parameters shall be EncodeableObject with same SOPC_EncodeableType.

Detailed Description

Deprecated and replacement is integrated into sopc_encodeabletype.h (Encodeable object services).

Deprecated

This file is deprecated since version 1.6.0 and will be removed in version 1.7.0. Please use replacement functions into sopc_encodeabletype.h and sopc_builtintypes.h instead.

Function Documentation

SOPC_Encodeable_Create()

SOPC_ReturnStatus SOPC_Encodeable_Create	(	SOPC_EncodeableType *	encTyp,
		void **	encObject )

Instantiate and initialize an encodeable object of the given encodeable type.

Deprecated

Use SOPC_EncodeableObject_Create instead.

Parameters

encTyp	Encodeable type of the encodeable object to instantiate and initialize
encObject	Pointer to be set with the address of the newly created encodeable object

Returns

SOPC_SOPC_STATUS_OK if creation succeeded

SOPC_Encodeable_Delete()

SOPC_ReturnStatus SOPC_Encodeable_Delete	(	SOPC_EncodeableType *	encTyp,
		void **	encObject )

Clear and deallocate an encodeable object of the given encodeable type.

Deprecated

Use SOPC_EncodeableObject_Delete instead.

Parameters

encTyp	Encodeable type of the encodeable object to deallocate
encObject	Pointer to the address of the encodeable object to delete (set to NULL if operation succeded)

Returns

SOPC_SOPC_STATUS_OK if deletion succeeded

SOPC_Encodeable_CreateExtension()

SOPC_ReturnStatus SOPC_Encodeable_CreateExtension	(	SOPC_ExtensionObject *	extObject,
		SOPC_EncodeableType *	encTyp,
		void **	encObject )

Create an encodeable object of the given encodeable type and set it in the given extension object.

Deprecated

Use SOPC_ExtensionObject_CreateObject instead.

Parameters

extObject	Extension object in which the newly created encodeable object must be set
encTyp	Encodeable type of the encodeable object to instantiate and initialize
encObject	Pointer to be set with the address of the newly created encodeable object

Returns

SOPC_SOPC_STATUS_OK if creation and extension setting succeeded

SOPC_Encodeable_Move()

SOPC_ReturnStatus SOPC_Encodeable_Move	(	void *	destObj,
		void *	srcObj )

Moves content of srcObj to destObj, i.e. copy srcObj structure content to destObj and reset srcObj. Both parameters shall be EncodeableObject with same SOPC_EncodeableType.

Deprecated

Use SOPC_EncodeableObject_Move instead.

Parameters

destObj	Empty and initialized encodeable object in which content of srcObj will be copied.
srcObj	Source encodeable object from which content will be copied into destObj and then reset.

Returns

SOPC_SOPC_STATUS_OK if move operation succeeded