ctai_handles.h File Reference

Utility functions for working with CTA_Handle objects. More...

Go to the source code of this file.

Functions
CTA_Datatype	CTAI_Handle_GetDatatype (const CTA_Handle handle)
	Get data type of object the given handle is referring to (internal use only!).
const char *	CTAI_Handle_GetName (const CTA_Handle handle)
	Get name associated with the handle (internal use only!).
const void *	CTAI_Handle_GetData (const CTA_Handle handle)
	Get data belonging to the handle (internal use only!).
int	CTAI_Handle_SetName (const CTA_Handle handle, const char *name)
	Set name associated with the handle (internal use only!).

---

Detailed Description

Utility functions for working with CTA_Handle objects.

Note:

This is just a set of utility routines it does not define any COSTA component

Definition in file ctai_handles.h.

---

Function Documentation

const void* CTAI_Handle_GetData

(

const CTA_Handle

handle

)

Get data belonging to the handle (internal use only!).

Parameters:

handle

I handle of which to get the data

Returns:

constant pointer to the data belonging to the handle

CTA_Datatype CTAI_Handle_GetDatatype

(

const CTA_Handle

handle

)

Get data type of object the given handle is referring to (internal use only!).

Parameters:

handle

I handle of which to get the data type

Returns:

data type associated with handle (no error codes)

const char* CTAI_Handle_GetName

(

const CTA_Handle

handle

)

Get name associated with the handle (internal use only!).

Parameters:

handle

I handle to get name of

Returns:

pointer to name associated with the given handle

int CTAI_Handle_SetName	(	const CTA_Handle	handle,
		const char *	name
	)

Set name associated with the handle (internal use only!).

Parameters:

	handle	IO handle of which to set the name
	name	I new name associated with handle

Returns:

CTA_OK is succesful