Reference handling

---

Detailed Description

Functions for reference handling.

Functions
gxi32	gx_refimage (gxHANDLE handle, gxIMAGE *pimage)
	Increases the image reference counter.
gxi32	gx_unrefimage (gxHANDLE handle, gxIMAGE *pimage)
	Decreases the image reference counter.
gxi32	gx_refimage (gxIMAGE *pimage)
	Increases the image reference counter.
gxi32	gx_unrefimage (gxIMAGE *pimage)
	Decreases the image reference counter.
int	gx_refhandle (gxHANDLE handle)
	Increases the reference counter of a GX handle.
int	gx_unrefhandle (gxHANDLE *handle)
	Decreases the reference counter of a GX handle.
int	gx_reftrafo (gxHANDLE handle, gxTRAFO *ptrafo)
	Increases the reference number of the specified transformation structure.
int	gx_unreftrafo (gxHANDLE handle, gxTRAFO *ptrafo)
	Decreases the reference number of the specified transformation structure.
int	gx_reftrafo (gxTRAFO *ptrafo)
	Increases the reference number of the specified transformation structure.
int	gx_unreftrafo (gxTRAFO *ptrafo)
	Decreases the reference number of the specified transformation structure.

---

Function Documentation

gxi32 gx_refimage	(	gxHANDLE	handle,
		gxIMAGE *	pimage
	)			[inline]

Increases the image reference counter.

The counter indicates the number of processes using the image. The counter can rise to positive or negative direction as well depending on whether the image is static or dynamic.

Parameters:

	handle	Handle of the module.
	pimage	Pointer to the image structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxImage::Attach(), and gx_refimage().

gxi32 gx_unrefimage	(	gxHANDLE	handle,
		gxIMAGE *	pimage
	)			[inline]

Decreases the image reference counter.

The counter indicates the number of processes using the image. If the counter value becomes zero after the function call the structure will be freed depending on whether the image was allocated statically or dynamically.

Parameters:

	handle	Handle of the module.
	pimage	Pointer to the image structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxImage::Attach(), gxImage::Detach(), gxImage::FromVariant(), and gx_unrefimage().

gxi32 gx_refimage

(

gxIMAGE *

pimage

)

[inline]

Increases the image reference counter.

The counter indicates the number of processes using the image. The counter can rise to positive or negative direction as well depending on whether the image is static or dynamic.

Parameters:

pimage

Pointer to the image structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_refimage().

gxi32 gx_unrefimage

(

gxIMAGE *

pimage

)

[inline]

Decreases the image reference counter.

The counter indicates the number of processes using the image. In case of the counter value becomes zero after the function call the structure will be freed depending on whether the image was allocated statically or dynamically.

Parameters:

pimage

Pointer to the image structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_unrefimage().

int gx_refhandle

(

gxHANDLE

handle

)

[inline]

Increases the reference counter of a GX handle.

Parameters:

handle

Handle of the module.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), and gxTrafoHandler::gxTrafoHandler().

int gx_unrefhandle

(

gxHANDLE *

handle

)

[inline]

Decreases the reference counter of a GX handle.

Parameters:

handle

Handle of the module.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxHandle::Close().

int gx_reftrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo
	)			[inline]

Increases the reference number of the specified transformation structure.

The reference number indicates how many processes are currently using the specified structure.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxTrafo::Attach(), and gx_reftrafo().

int gx_unreftrafo	(	gxHANDLE	handle,
		gxTRAFO *	ptrafo
	)			[inline]

Decreases the reference number of the specified transformation structure.

As it reaches value zero the structure will be freed.

Parameters:

	handle	Handle of the module.
	ptrafo	Pointer to an initialized structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_call().

Referenced by gxTrafo::Attach(), gxTrafo::Detach(), gxTrafo::FromVariant(), and gx_unreftrafo().

int gx_reftrafo

(

gxTRAFO *

ptrafo

)

[inline]

Increases the reference number of the specified transformation structure.

The reference number indicates how many processes are currently using the specified structure.

Parameters:

ptrafo

Pointer to an initialized structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_reftrafo().

int gx_unreftrafo

(

gxTRAFO *

ptrafo

)

[inline]

Decreases the reference number of the specified transformation structure.

As it reaches value zero the structure will be freed.

Parameters:

ptrafo

Pointer to an initialized structure.

Returns:

On error false is returned and the error code/string in the GX system is set appropriately ( see gx_geterror() ).

References gx_direct(), and gx_unreftrafo().