gxZip Class Reference

Inheritance diagram for gxZip:

List of all members.

---

Detailed Description

Class for the Zip functions.

The gxZip class does not use properties.

Public Member Functions
	gxZip () throw (gxError)
	Class initialization.
bool	IsValid (void) const
	Checks if the handler of a module is valid.
bool	Create (const wchar_t *filename, int mode) throw (gxError)
	Creates a ZIP file (Unicode version).
bool	Create (const char *filename, int mode) throw (gxError)
	Creates a ZIP file (ASCII version).
bool	Create (gxInStr filename, int mode) throw (gxError)
	Creates a ZIP file (Unicode version).
bool	Create (gxInAStr filename, int mode) throw (gxError)
	Creates a ZIP file (ASCII version).
bool	Open (const wchar_t *filename) throw (gxError)
	Opens a ZIP file (Unicode version).
bool	Open (const char *filename) throw (gxError)
	Opens a ZIP file (ASCII version).
bool	Open (gxInStr filename) throw (gxError)
	Opens a ZIP file (Unicode version).
bool	Open (gxInAStr filename) throw (gxError)
	Opens a ZIP file (ASCII version).
bool	CreateZipInMemory (int mode) throw (gxError)
	Creates a ZIP file in memory.
bool	GetZipInMemory (void **pbuffer, int *pbuflen) throw (gxError)
	Get the created ZIP file in memory.
bool	OpenZipInMemory (void *buffer, int buflen) throw (gxError)
	Opens a ZIP file in memory.
bool	Close (const wchar_t *comment) throw (gxError)
	Closes an opened/created ZIP file (Unicode version).
bool	Close (const char *comment) throw (gxError)
	Closes an opened/created ZIP file (ASCII version).
bool	Close (gxInStr comment) throw (gxError)
	Closes an opened/created ZIP file (Unicode version).
bool	Close (gxInAStr comment) throw (gxError)
	Closes an opened/created ZIP file (ASCII version).
bool	Close (void) throw (gxError)
	Closes an opened/created ZIP file.
bool	GetInfo (GX_PARM_GETZIPINFO *info) throw (gxError)
	Gives informations about the opened ZIP file.
int	GetNEntries (void) throw (gxError)
	Gives the number of file entries in the archive.
int	GetCommentLength (void) throw (gxError)
	Gives the length of the comment field in bytes.
bool	GetComment (wchar_t *target, int *tlen) throw (gxError)
	Reads the comment from the archive (Unicode version).
bool	GetComment (char *target, int *tlen) throw (gxError)
	Reads the comment from the archive.
gxOutStr	GetComment (void) throw (gxError)
	Reads the comment from the archive (Unicode version).
gxOutAStr	GetCommentA (void) throw (gxError)
	Reads the comment from the archive (ASCII version).
bool	CreateFile (GX_PARM_CREATEFILEINZIPW *cfz) throw (gxError)
	Creates a file in the archive (Unicode version).
bool	CreateFile (GX_PARM_CREATEFILEINZIP *cfz) throw (gxError)
	Creates a file in the archive.
bool	CreateFile (gxInStr filename, int level, int strategy, gxInStr comment, gxZipFileInfo &info)
	Creates file in ZIP (Unicode version).
bool	CreateFile (gxInAStr filename, int level, int strategy, gxInAStr comment, gxZipFileInfo &info)
	Creates file in ZIP (ASCII version).
bool	CreateFile (const wchar_t *filename, int level, int strategy, const wchar_t *comment)
	Creates file in ZIP (Unicode version).
bool	CreateFile (const char *filename, int level, int strategy, const char *comment)
	Creates file in ZIP (ASCII version).
bool	CreateFile (gxInStr filename, int level, int strategy, gxInStr comment)
	Creates file in ZIP (Unicode version).
bool	CreateFile (gxInAStr filename, int level, int strategy, gxInAStr comment)
	Creates file in ZIP (ASCII version).
bool	WriteToFile (const void *buffer, int buflen) throw (gxError)
	Writes data to the current file in the archive.
bool	CloseFile (void) throw (gxError)
	Closes the current file in the archive.
bool	FirstFile (GX_ZIPFILEDETINFOW *finfo)
	Sets marker to the first file in the archive (Unicode version).
bool	FirstFile (GX_ZIPFILEDETINFO *finfo)
	Sets marker to the first file in the archive (ASCII version).
bool	FirstFile (void)
	Sets marker to the first file in the archive.
bool	NextFile (GX_ZIPFILEDETINFOW *finfo)
	Sets marker to the next file in the archive (Unicode version).
bool	NextFile (GX_ZIPFILEDETINFO *finfo)
	Sets marker to the next file in the archive (ASCII version).
bool	NextFile (void)
	Sets marker to the next file in the archive.
bool	LocateFile (GX_ZIPFILEDETINFOW *finfo, const wchar_t *filename, int casesensitivity=0) throw (gxError)
	Sets marker to the specified file in the archive (Unicode version).
bool	LocateFile (GX_ZIPFILEDETINFO *finfo, const char *filename, int casesensitivity=0) throw (gxError)
	Sets marker to the specified file in the archive (ASCII version).
bool	LocateFile (gxInStr filename, int casesensitivity=0) throw (gxError)
	Sets marker to the specified file in the archive (Unicode version).
bool	LocateFile (gxInAStr filename, int casesensitivity=0) throw (gxError)
	Sets marker to the specified file in the archive (ASCII version).
bool	FileInfo (GX_ZIPFILEDETINFO *finfo) throw (gxError)
	Gives information about a marked file in the archive.
bool	FileInfo (GX_ZIPFILEDETINFOW *finfo) throw (gxError)
	Gives information about a marked file in the archive (Unicode version).
gxZipFileInfo	GetFileInfo (void) throw (gxError)
	Gives the information of the marked file.
gxZipFileDetInfo	GetFileDetInfo (void) throw (gxError)
	Gives the detailed information of the marked file.
gxOutStr	GetFileName (void)
	Retrieves the name of the file in the ZIP.
gxOutAStr	GetFileNameA (void)
	Retrieves the name of the file in the ZIP (ASCII version).
gxOutStr	GetFileComment (void)
	Retrieves the comment of the file in the ZIP.
gxOutAStr	GetFileCommentA (void)
	Retrieves the comment of the file in the ZIP (ASCII version).
bool	OpenFile (int *method, int *level, const wchar_t *password) throw (gxError)
	Opens a marked file in the archive (Unicode version).
bool	OpenFile (int *method, int *level=(int *) 0, const char *password=(const char *) 0) throw (gxError)
	Opens a marked file in the archive (ASCII version).
bool	OpenFile (void) throw (gxError)
	Opens a marked file in the archive.
bool	OpenFile (gxInStr password) throw (gxError)
	Opens a marked file in the archive (Unicode version).
bool	OpenFile (gxInAStr password) throw (gxError)
	Opens a marked file in the archive (ASCII version).
int	GetFileMethod (void) throw (gxError)
	Retrieves the method of the last opened file in the ZIP.
int	GetFileLevel (void) throw (gxError)
	Retrieves the compression level of the last opened file in the ZIP.
bool	ReadFromFile (void *target, int *tlen) throw (gxError)
	Reads the content of an opened file in the ZIP archive.
bool	CalculateCRC (unsigned int *crc, const void *buffer, int buflen) throw (gxError)
	Calculates CRC-32 value from the specified buffer for the encrypted archive.
bool	GetInitialCRC (unsigned int *crc) throw (gxError)
	Retrieves the initial CRC for the gxZip::CalculateCRC().
unsigned int	GetInitialCRC (void) throw (gxError)
	Returns the initial CRC for the gxZip::CalculateCRC().
bool	ReadLocalExtraField (void *buffer, int *buflen) throw (gxError)
	Reads the local extra field of the marked file in the archive.
void	Dispose (void)
	It disposes the class.
bool	Open (const wchar_t *modulename, const wchar_t *groupname=(const wchar_t *) 0) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (const char *modulename, const char *groupname=(const char *) 0) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	Open (gxInStr modulename, gxInStr groupname) throw (gxError)
	Opens a GX system compatible module (Unicode version).
bool	Open (gxInAStr modulename, gxInAStr groupname) throw (gxError)
	Opens a GX system compatible module (ASCII version).
bool	GetInfo (const gxMODULEINFO **moduleinfo) throw (gxError)
	Gives information about an opened module.
bool	Call (int callcode, void *params)
	Calls a process of the module with its parameters.
bool	GetProperty (const wchar_t *name, wchar_t *string, int maxlen) throw (gxError)
	Gets a property of the specified module (Unicode version).
std::wstring	GetProperty (const wchar_t *name) throw (gxError)
	Gets a property of the specified module (Unicode version).
bool	GetProperty (const char *name, char *string, int maxlen) throw (gxError)
	Gets a property of the specified module (ASCII version).
std::string	GetProperty (const char *name) throw (gxError)
	Gets a property of the specified module (ASCII version).
gxOutStr	GetProperty (gxInStr name) throw (gxError)
	Gets a property of the specified module (Unicode version).
gxOutAStr	GetProperty (gxInAStr name) throw (gxError)
	Gets a property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
bool	GetProperty (const char *name, int *ivalue) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
bool	GetProperty (const wchar_t *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
bool	GetProperty (const char *name, double *fvalue) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
int	GetPropertyInt (const wchar_t *name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (gxInStr name) throw (gxError)
	Gets an integer property of the specified module (Unicode version).
int	GetPropertyInt (const char *name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
int	GetPropertyInt (gxInAStr name) throw (gxError)
	Gets an integer property of the specified module (ASCII version).
double	GetPropertyFloat (const wchar_t *name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (gxInStr name) throw (gxError)
	Gets a floating-point property of the specified module (Unicode version).
double	GetPropertyFloat (const char *name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
double	GetPropertyFloat (gxInAStr name) throw (gxError)
	Gets a floating-point property of the specified module (ASCII version).
bool	GetPropertyVersion (const wchar_t *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (const wchar_t *name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
unsigned int	GetPropertyVersion (gxInStr name) throw (gxError)
	Gets a version property of the specified module (Unicode version).
bool	GetPropertyVersion (const char *name, unsigned int *version) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (const char *name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
unsigned int	GetPropertyVersion (gxInAStr name) throw (gxError)
	Gets a version property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, const wchar_t *string) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (const char *name, const char *string) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, gxInStr str) throw (gxError)
	Sets a property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, gxInAStr str) throw (gxError)
	Sets a property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (const char *name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, int ivalue) throw (gxError)
	Sets an integer property of the specified module (ASCII version).
bool	SetProperty (const wchar_t *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (const char *name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SetProperty (gxInStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (Unicode version).
bool	SetProperty (gxInAStr name, double fvalue) throw (gxError)
	Sets a floating-point property of the specified module (ASCII version).
bool	SaveProperties (const wchar_t *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (const char *name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	SaveProperties (gxInStr name, int level) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInStr name) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).
bool	SaveProperties (gxInAStr name, int level=0) throw (gxError)
	Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).
bool	MPStartTransaction (void)
	It starts the property transaction.
bool	MPCommit (void)
	It ends the property transaction and updates your changes to module.
Public Attributes
gxu32	handle
	Handle of the module.

---

Constructor & Destructor Documentation

gxZip

(

)

throw (gxError) [inline]

Class initialization.

References gx_openmodule().

---

Member Function Documentation

bool IsValid

(

void

)

const [inline]

Checks if the handler of a module is valid.

Returns:

In case of existing handler the return value is non-zero.

Reimplemented from gxHandle.

References gxHandle::IsValid().

bool Create	(	const wchar_t *	filename,
		int	mode
	)			throw (gxError) [inline]

Creates a ZIP file (Unicode version).

Parameters:

	filename	Path and name of the ZIP file.
	mode	Create mode (see GX_CREATEZIPMODES).

Returns:

An exception is thrown or false is returned in case of error.

References gx_createzip().

bool Create	(	const char *	filename,
		int	mode
	)			throw (gxError) [inline]

Creates a ZIP file (ASCII version).

Parameters:

	filename	Path and name of the ZIP file.
	mode	Create mode (see GX_CREATEZIPMODES).

Returns:

An exception is thrown or false is returned in case of error.

References gx_createzipa().

bool Create	(	gxInStr	filename,
		int	mode
	)			throw (gxError) [inline]

Creates a ZIP file (Unicode version).

Parameters:

	filename	Path and name of the ZIP file.
	mode	Create mode (see GX_CREATEZIPMODES).

Returns:

An exception is thrown or false is returned in case of error.

References gx_createzip().

bool Create	(	gxInAStr	filename,
		int	mode
	)			throw (gxError) [inline]

Creates a ZIP file (ASCII version).

Parameters:

	filename	Path and name of the ZIP file.
	mode	Create mode (see GX_CREATEZIPMODES).

Returns:

An exception is thrown or false is returned in case of error.

References gx_createzipa().

bool Open

(

const wchar_t *

filename

)

throw (gxError) [inline]

Opens a ZIP file (Unicode version).

Parameters:

filename

Path and name of the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openzip().

bool Open

(

const char *

filename

)

throw (gxError) [inline]

Opens a ZIP file (ASCII version).

Parameters:

filename

Path and name of the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openzipa().

bool Open

(

gxInStr

filename

)

throw (gxError) [inline]

Opens a ZIP file (Unicode version).

Parameters:

filename

Path and name of the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented from gxHandle.

References gx_openzip().

bool Open

(

gxInAStr

filename

)

throw (gxError) [inline]

Opens a ZIP file (ASCII version).

Parameters:

filename

Path and name of the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented from gxHandle.

References gx_openzipa().

bool CreateZipInMemory

(

int

mode

)

throw (gxError) [inline]

Creates a ZIP file in memory.

Parameters:

mode

Create mode (see GX_CREATEZIPMODES).

Returns:

An exception is thrown or false is returned in case of error.

References gx_createzipinmemory().

bool GetZipInMemory	(	void **	pbuffer,
		int *	pbuflen
	)			throw (gxError) [inline]

Get the created ZIP file in memory.

Parameters:

	pbuffer	Pointer to the ZIP file in memory.
	pbuflen	Pointer to the length of the ZIP file in memory.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getzipinmemory().

bool OpenZipInMemory	(	void *	buffer,
		int	buflen
	)			throw (gxError) [inline]

Opens a ZIP file in memory.

Parameters:

	buffer	The ZIP file in memory.
	buflen	The length of the ZIP file in memory.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openzipinmemory().

bool Close

(

const wchar_t *

comment

)

throw (gxError) [inline]

Closes an opened/created ZIP file (Unicode version).

Parameters:

comment

Comment string for the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_closezip().

bool Close

(

const char *

comment

)

throw (gxError) [inline]

Closes an opened/created ZIP file (ASCII version).

Parameters:

comment

Comment string for the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_closezip().

bool Close

(

gxInStr

comment

)

throw (gxError) [inline]

Closes an opened/created ZIP file (Unicode version).

Parameters:

comment

Comment string for the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_closezip().

bool Close

(

gxInAStr

comment

)

throw (gxError) [inline]

Closes an opened/created ZIP file (ASCII version).

Parameters:

comment

Comment string for the ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_closezipa().

bool Close

(

void

)

throw (gxError) [inline]

Closes an opened/created ZIP file.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented from gxHandle.

References gx_closezipa().

bool GetInfo

(

GX_PARM_GETZIPINFO *

info

)

throw (gxError) [inline]

Gives informations about the opened ZIP file.

Parameters:

info

Pointer to an information structure where the function fills it.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getzipinfo().

int GetNEntries

(

void

)

throw (gxError) [inline]

Gives the number of file entries in the archive.

Returns:

Number of file entries in the archive. If an error occurred the function will thrown an exception.

References gx_getzipinfo().

int GetCommentLength

(

void

)

throw (gxError) [inline]

Gives the length of the comment field in bytes.

Returns:

Length of comment in bytes. If an error occurred the function will thrown an exception.

References gx_getzipinfo().

bool GetComment	(	wchar_t *	target,
		int *	tlen
	)			throw (gxError) [inline]

Reads the comment from the archive (Unicode version).

Parameters:

	target	Pointer to an allocated area where the function writes the comment string.
	tlen	Length of the allocated area in characters.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getzipcomment().

bool GetComment	(	char *	target,
		int *	tlen
	)			throw (gxError) [inline]

Reads the comment from the archive.

Parameters:

	target	Pointer to an allocated area where the function writes the comment string.
	tlen	Length of the allocated area.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getzipcomment().

gxOutStr GetComment

(

void

)

throw (gxError) [inline]

Reads the comment from the archive (Unicode version).

Returns:

The comment string. If an error occurred the function will thrown an exception.

References gx_getzipcomment(), gx_globalalloc(), and gx_globalfree().

gxOutAStr GetCommentA

(

void

)

throw (gxError) [inline]

Reads the comment from the archive (ASCII version).

Returns:

The comment string. If an error occurred the function will thrown an exception.

References gx_getzipcommenta(), gx_globalalloc(), and gx_globalfree().

bool CreateFile

(

GX_PARM_CREATEFILEINZIPW *

cfz

)

throw (gxError) [inline]

Creates a file in the archive (Unicode version).

Parameters:

cfz

Pointer to the description structure.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzip().

bool CreateFile

(

GX_PARM_CREATEFILEINZIP *

cfz

)

throw (gxError) [inline]

Creates a file in the archive.

Parameters:

cfz

Pointer to the description structure.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzipa().

bool CreateFile	(	gxInStr	filename,
		int	level,
		int	strategy,
		gxInStr	comment,
		gxZipFileInfo &	info
	)			[inline]

Creates file in ZIP (Unicode version).

Parameters:

	filename	The name of the file in ZIP.
	level	Compression level (see GX_ZLEVELS).
	strategy	Compression strategy (see GX_ZSTRATEGIES).
	comment	Comment for the file in the ZIP.
	info	Detailed information for the file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzip().

bool CreateFile	(	gxInAStr	filename,
		int	level,
		int	strategy,
		gxInAStr	comment,
		gxZipFileInfo &	info
	)			[inline]

Creates file in ZIP (ASCII version).

Parameters:

	filename	The name of the file in ZIP.
	level	Compression level (see GX_ZLEVELS).
	strategy	Compression strategy (see GX_ZSTRATEGIES).
	comment	Comment for the file in the ZIP.
	info	Detailed information for the file.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzipa().

bool CreateFile	(	const wchar_t *	filename,
		int	level,
		int	strategy,
		const wchar_t *	comment
	)			[inline]

Creates file in ZIP (Unicode version).

Parameters:

	filename	The name of the file in ZIP.
	level	Compression level (see GX_ZLEVELS).
	strategy	Compression strategy (see GX_ZSTRATEGIES).
	comment	Comment for the file in the ZIP.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzip().

bool CreateFile	(	const char *	filename,
		int	level,
		int	strategy,
		const char *	comment
	)			[inline]

Creates file in ZIP (ASCII version).

Parameters:

	filename	The name of the file in ZIP.
	level	Compression level (see GX_ZLEVELS).
	strategy	Compression strategy (see GX_ZSTRATEGIES).
	comment	Comment for the file in the ZIP.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzipa().

bool CreateFile	(	gxInStr	filename,
		int	level,
		int	strategy,
		gxInStr	comment
	)			[inline]

Creates file in ZIP (Unicode version).

Parameters:

	filename	The name of the file in ZIP.
	level	Compression level (see GX_ZLEVELS).
	strategy	Compression strategy (see GX_ZSTRATEGIES).
	comment	Comment for the file in the ZIP.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzip().

bool CreateFile	(	gxInAStr	filename,
		int	level,
		int	strategy,
		gxInAStr	comment
	)			[inline]

Creates file in ZIP (ASCII version).

Parameters:

	filename	The name of the file in ZIP.
	level	Compression level (see GX_ZLEVELS).
	strategy	Compression strategy (see GX_ZSTRATEGIES).
	comment	Comment for the file in the ZIP.

Returns:

An exception is thrown or false is returned in case of error.

References gx_createfileinzipa().

bool WriteToFile	(	const void *	buffer,
		int	buflen
	)			throw (gxError) [inline]

Writes data to the current file in the archive.

Parameters:

	buffer	Pointer to data.
	buflen	Length of data in bytes.

Returns:

An exception is thrown or false is returned in case of error.

References gx_writetofileinzip().

bool CloseFile

(

void

)

throw (gxError) [inline]

Closes the current file in the archive.

Returns:

An exception is thrown or false is returned in case of error.

References gx_closefileinzip().

bool FirstFile

(

GX_ZIPFILEDETINFOW *

finfo

)

[inline]

Sets marker to the first file in the archive (Unicode version).

Parameters:

finfo

Pointer to the information structure. The function will fill it.

Returns:

The function returns true if no error.

References gx_firstfileinzip().

bool FirstFile

(

GX_ZIPFILEDETINFO *

finfo

)

[inline]

Sets marker to the first file in the archive (ASCII version).

Parameters:

finfo

Pointer to the information structure. The function will fill it.

Returns:

The function returns true if no error.

References gx_firstfileinzip().

bool FirstFile

(

void

)

[inline]

Sets marker to the first file in the archive.

Returns:

Returns true if no error.

References gx_firstfileinzip().

bool NextFile

(

GX_ZIPFILEDETINFOW *

finfo

)

[inline]

Sets marker to the next file in the archive (Unicode version).

Parameters:

finfo

Pointer to the information structure. The function will fill it.

Returns:

The function returns true if no error.

References gx_nextfileinzip().

bool NextFile

(

GX_ZIPFILEDETINFO *

finfo

)

[inline]

Sets marker to the next file in the archive (ASCII version).

Parameters:

finfo

Pointer to the information structure. The function will fill it.

Returns:

The function returns true if no error.

References gx_nextfileinzip().

bool NextFile

(

void

)

[inline]

Sets marker to the next file in the archive.

Returns:

Returns true if no error.

References gx_nextfileinzip().

bool LocateFile	(	GX_ZIPFILEDETINFOW *	finfo,
		const wchar_t *	filename,
		int	casesensitivity = 0
	)			throw (gxError) [inline]

Sets marker to the specified file in the archive (Unicode version).

Parameters:

	finfo	Pointer to the information structure. The function will fill it.
	filename	Name of the file in the archive.
	casesensitivity	Case sensitivity signification. It can be: 1: comparision is case sensitive (like strcmp) 2: comparision is not case sensitive (like strcmpi/strcasecmp) 0: case sensitivity is the default of your operation system (like 1 on Unix, 2 on Windows)

Returns:

Returns true if no error.

References gx_locatefileinzip().

bool LocateFile	(	GX_ZIPFILEDETINFO *	finfo,
		const char *	filename,
		int	casesensitivity = 0
	)			throw (gxError) [inline]

Sets marker to the specified file in the archive (ASCII version).

Parameters:

	finfo	Pointer to the information structure. The function will fill it.
	filename	Name of the file in the archive.
	casesensitivity	Case sensitivity signification. It can be: 1: comparision is case sensitive (like strcmp) 2: comparision is not case sensitive (like strcmpi/strcasecmp) 0: case sensitivity is the default of your operation system (like 1 on Unix, 2 on Windows)

Returns:

Returns true if no error.

References gx_locatefileinzipa().

bool LocateFile	(	gxInStr	filename,
		int	casesensitivity = 0
	)			throw (gxError) [inline]

Sets marker to the specified file in the archive (Unicode version).

Parameters:

	filename	Name of the file in the archive.
	casesensitivity	Case sensitivity signification. It can be: 1: comparision is case sensitive (like strcmp) 2: comparision is not case sensitive (like strcmpi/strcasecmp) 0: case sensitivity is the default of your operation system (like 1 on Unix, 2 on Windows)

Returns:

Returns true if no error.

References gx_locatefileinzip().

bool LocateFile	(	gxInAStr	filename,
		int	casesensitivity = 0
	)			throw (gxError) [inline]

Sets marker to the specified file in the archive (ASCII version).

Parameters:

	filename	Name of the file in the archive.
	casesensitivity	Case sensitivity signification. It can be: 1: comparision is case sensitive (like strcmp) 2: comparision is not case sensitive (like strcmpi/strcasecmp) 0: case sensitivity is the default of your operation system (like 1 on Unix, 2 on Windows)

Returns:

Returns true if no error.

References gx_locatefileinzipa().

bool FileInfo

(

GX_ZIPFILEDETINFO *

finfo

)

throw (gxError) [inline]

Gives information about a marked file in the archive.

Parameters:

finfo

Pointer to the information structure. The function will fill it.

Returns:

An exception is thrown or false is returned in case of error.

References gx_fileinfoinzip().

bool FileInfo

(

GX_ZIPFILEDETINFOW *

finfo

)

throw (gxError) [inline]

Gives information about a marked file in the archive (Unicode version).

Parameters:

finfo

Pointer to the information structure. The function will fill it.

Returns:

An exception is thrown or false is returned in case of error.

References gx_fileinfoinzip().

gxZipFileInfo GetFileInfo

(

void

)

throw (gxError) [inline]

Gives the information of the marked file.

Returns:

The information structure. If an error occurred the function will thrown an exception.

References gxZipFileInfo::dosdate, gxZipFileInfo::external_fa, gx_fileinfoinzip(), gxZipFileInfo::internal_fa, gxZipFileInfo::tm_hour, gxZipFileInfo::tm_mday, gxZipFileInfo::tm_min, gxZipFileInfo::tm_mon, gxZipFileInfo::tm_sec, and gxZipFileInfo::tm_year.

gxZipFileDetInfo GetFileDetInfo

(

void

)

throw (gxError) [inline]

Gives the detailed information of the marked file.

Returns:

The information structure. If an error occurred the function will thrown an exception.

References gxZipFileDetInfo::compressed_size, gxZipFileDetInfo::crc, gxZipFileDetInfo::disk_num_start, gxZipFileDetInfo::flag, gx_fileinfoinzip(), gxZipFileDetInfo::method, gxZipFileDetInfo::size_file_comment, gxZipFileDetInfo::size_file_extra, gxZipFileDetInfo::size_filename, gxZipFileDetInfo::uncompressed_size, gxZipFileDetInfo::version, and gxZipFileDetInfo::version_needed.

gxOutStr GetFileName

(

void

)

[inline]

Retrieves the name of the file in the ZIP.

Returns:

Name of the file. If an error occurred the function will thrown an error.

References gx_fileinfoinzip(), gx_globalalloc(), and gx_globalfree().

gxOutAStr GetFileNameA

(

void

)

[inline]

Retrieves the name of the file in the ZIP (ASCII version).

Returns:

Name of the file. If an error occurred the function will thrown an error.

References gx_fileinfoinzipa(), gx_globalalloc(), and gx_globalfree().

gxOutStr GetFileComment

(

void

)

[inline]

Retrieves the comment of the file in the ZIP.

Returns:

Comment of the file. If an error occurred the function will thrown an error.

References gx_fileinfoinzip(), gx_globalalloc(), and gx_globalfree().

gxOutAStr GetFileCommentA

(

void

)

[inline]

Retrieves the comment of the file in the ZIP (ASCII version).

Returns:

Comment of the file. If an error occurred the function will thrown an error.

References gx_fileinfoinzipa(), gx_globalalloc(), and gx_globalfree().

bool OpenFile	(	int *	method,
		int *	level,
		const wchar_t *	password
	)			throw (gxError) [inline]

Opens a marked file in the archive (Unicode version).

Parameters:

	method	Pointer to an integer. The function will update it to the compression method.
	level	Pointer to an integer. The function will update it to the compression level.
	password	Password string if the file is encoded. It can be NULL.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openfileinzip().

bool OpenFile	(	int *	method,
		int *	level = (int *)0,
		const char *	password = (const char *)0
	)			throw (gxError) [inline]

Opens a marked file in the archive (ASCII version).

Parameters:

	method	Pointer to an integer. The function will update it to the compression method.
	level	Pointer to an integer. The function will update it to the compression level.
	password	Password string if the file is encoded. It can be NULL.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openfileinzipa().

bool OpenFile

(

void

)

throw (gxError) [inline]

Opens a marked file in the archive.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openfileinzipa().

bool OpenFile

(

gxInStr

password

)

throw (gxError) [inline]

Opens a marked file in the archive (Unicode version).

Parameters:

password

Password for authentication.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openfileinzip().

bool OpenFile

(

gxInAStr

password

)

throw (gxError) [inline]

Opens a marked file in the archive (ASCII version).

Parameters:

password

Password for authentication.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openfileinzipa().

int GetFileMethod

(

void

)

throw (gxError) [inline]

Retrieves the method of the last opened file in the ZIP.

Returns:

Compression method of the last opened file.

int GetFileLevel

(

void

)

throw (gxError) [inline]

Retrieves the compression level of the last opened file in the ZIP.

Returns:

Compression level of the last opened file.

bool ReadFromFile	(	void *	target,
		int *	tlen
	)			throw (gxError) [inline]

Reads the content of an opened file in the ZIP archive.

Parameters:

	target	Pointer to an allocated area.
	tlen	Length of the allocated area in bytes.

Returns:

An exception is thrown or false is returned in case of error.

References gx_readfromfileinzip().

bool CalculateCRC	(	unsigned int *	crc,
		const void *	buffer,
		int	buflen
	)			throw (gxError) [inline]

Calculates CRC-32 value from the specified buffer for the encrypted archive.

Parameters:

	crc	The initial CRC-32 value. The function will update it with the calculated CRC.
	buffer	Pointer to data.
	buflen	Length of the data in bytes.

Returns:

An exception is thrown or false is returned in case of error.

References gx_calculatezipcrc().

bool GetInitialCRC

(

unsigned int *

crc

)

throw (gxError) [inline]

Retrieves the initial CRC for the gxZip::CalculateCRC().

Parameters:

crc

Pointer to an area, the function will be updated it with the initial CRC.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getinitialzipcrc().

unsigned int GetInitialCRC

(

void

)

throw (gxError) [inline]

Returns the initial CRC for the gxZip::CalculateCRC().

Returns:

The initial CRC. If an error occurred the function throws an exception.

References gx_getinitialzipcrc().

bool ReadLocalExtraField	(	void *	buffer,
		int *	buflen
	)			throw (gxError) [inline]

Reads the local extra field of the marked file in the archive.

Parameters:

	buffer	Pointer to data.
	buflen	Length of the data in bytes.

Returns:

On success: non-zero ( see gx_geterror() )

References gx_readlexfieldzip().

void Dispose

(

void

)

[inline, inherited]

It disposes the class.

no base class.

Reimplemented in gxImage, gxLog, and gxTrafo.

Referenced by gxTrafo::Dispose(), gxLog::Dispose(), and gxImage::Dispose().

bool Open	(	const wchar_t *	modulename,
		const wchar_t *	groupname = (const wchar_t *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	const char *	modulename,
		const char *	groupname = (const char *)0
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	gxInStr	modulename,
		gxInStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (Unicode version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodule().

bool Open	(	gxInAStr	modulename,
		gxInAStr	groupname
	)			throw (gxError) [inline, inherited]

Opens a GX system compatible module (ASCII version).

Parameters:

	modulename	Name of the module.
	groupname	Property place in the property tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_openmodulea().

bool GetInfo

(

const gxMODULEINFO **

moduleinfo

)

throw (gxError) [inline, inherited]

Gives information about an opened module.

Parameters:

moduleinfo

Pointer to an information structure pointer where the system returns the data of the specified module.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmoduleinfo().

bool Call	(	int	callcode,
		void *	params
	)			[inline, inherited]

Calls a process of the module with its parameters.

The functions and parameters usable inside the modules can be found in the documentation of the modules. The headers given with the modules contain inline functions, which make easier to access the functions of the module.

Parameters:

	callcode	Call code for the function (GX_CALL_xxx call codes).
	params	Parameters to give for the function (GX_PARM_xxx structures).

Returns:

Module defined, usually success is true.

References gx_call().

bool GetProperty	(	const wchar_t *	name,
		wchar_t *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::wstring GetProperty

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

bool GetProperty	(	const char *	name,
		char *	string,
		int	maxlen
	)			throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Pointer to a memory area where to store the value.
	maxlen	Size of memory area in characters (not bytes).

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

std::string GetProperty

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutStr GetProperty

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmoduleproperty().

gxOutAStr GetProperty

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

Value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertya().

bool GetProperty	(	const wchar_t *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

bool GetProperty	(	const char *	name,
		int *	ivalue
	)			throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	Pointer to an integer where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

bool GetProperty	(	const wchar_t *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

bool GetProperty	(	const char *	name,
		double *	fvalue
	)			throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	Pointer to a floating-point where to store the value.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

int GetPropertyInt

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyint().

int GetPropertyInt

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyint().

int GetPropertyInt

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyinta().

int GetPropertyInt

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets an integer property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyinta().

double GetPropertyFloat

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloat().

double GetPropertyFloat

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyfloata().

double GetPropertyFloat

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a floating-point property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The floating-point value of the property or an exception is thrown in case of error.

Reimplemented in gxProperty.

References gx_getmodulepropertyfloata().

bool GetPropertyVersion	(	const wchar_t *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

const wchar_t *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

unsigned int GetPropertyVersion

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (Unicode version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversion().

bool GetPropertyVersion	(	const char *	name,
		unsigned int *	version
	)			throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	version	Pointer to an integer where to store the version.

Returns:

An exception is thrown or false is returned in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

const char *

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

unsigned int GetPropertyVersion

(

gxInAStr

name

)

throw (gxError) [inline, inherited]

Gets a version property of the specified module (ASCII version).

Parameters:

name

Name of the property.

Returns:

The integer value of the property or an exception is thrown in case of error.

References gx_getmodulepropertyversiona().

bool SetProperty	(	const wchar_t *	name,
		const wchar_t *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	const char *	name,
		const char *	string
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	string	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	gxInStr	name,
		gxInStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmoduleproperty().

bool SetProperty	(	gxInAStr	name,
		gxInAStr	str
	)			throw (gxError) [inline, inherited]

Sets a property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	str	Value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertya().

bool SetProperty	(	const wchar_t *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	const char *	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	gxInStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyint().

bool SetProperty	(	gxInAStr	name,
		int	ivalue
	)			throw (gxError) [inline, inherited]

Sets an integer property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	ivalue	An integer value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyinta().

bool SetProperty	(	const wchar_t *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	const char *	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SetProperty	(	gxInStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (Unicode version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloat().

bool SetProperty	(	gxInAStr	name,
		double	fvalue
	)			throw (gxError) [inline, inherited]

Sets a floating-point property of the specified module (ASCII version).

Parameters:

	name	Name of the property.
	fvalue	A floating-point value of the property.

Returns:

An exception is thrown or false is returned in case of error.

Reimplemented in gxProperty.

References gx_setmodulepropertyfloata().

bool SaveProperties	(	const wchar_t *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	const char *	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInStr	name,
		int	level
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties

(

gxInStr

name

)

throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (Unicode version).

Parameters:

name

Place of property in the tree.

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemoduleproperties().

bool SaveProperties	(	gxInAStr	name,
		int	level = 0
	)			throw (gxError) [inline, inherited]

Saves the properties of a module stored in the memory to a branch of the property tree stored on a mass storage device (ASCII version).

Parameters:

	name	Place of property in the tree.
	level	Higher numbers give more details (0 = basic properties, 100 = all properties).

Returns:

An exception is thrown or false is returned in case of error.

References gx_savemodulepropertiesa().

bool MPStartTransaction

(

void

)

[inline, inherited]

It starts the property transaction.

The module accepts but doesn't update properties (setmoduleproperty). You must use 'gx_mpcommit' to update these properties.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpstarttransaction().

bool MPCommit

(

void

)

[inline, inherited]

It ends the property transaction and updates your changes to module.

Warning:

Not supported by each module!

Returns:

An exception is thrown or false is returned in case of error.

References gx_mpcommit().

---

Member Data Documentation

gxu32 handle [inherited]

Handle of the module.

If it is zero, it is invalid.

See also:

gx_isvalidhandle()

Referenced by gx_closehandle(), gx_direct(), gx_isvalidhandle(), gxHandle::gxHandle(), gxImageHandler::gxImageHandler(), gxTrafoHandler::gxTrafoHandler(), and gxHandle::operator=().