PxConfigClose(), PxConfigCloseCx()

Close a configuration file

Synopsis:

#include <photon/PxProto.h>

int PxConfigClose( void );

int PxConfigCloseCx(PxCfgContext_t *cx);

Arguments:

cx: PxConfigCloseCx() only. The configuration file handle for the file you want to close. This handle is returned by PxConfigOpenCx().

Library:

phexlib

Description:

These functions close a configuration file, and release all the resources associated with that file.

PxConfigClose() closes the currently opened configuration file (opened using PxConfigOpen()). It doesn't do anything and returns Pt_FALSE if there's no currently opened configuration file.

PxConfigCloseCx() closes the configuration file indicated by cx (opened using PxConfigOpenCx()). It doesn't do anything and returns Pt_FALSE if cx is NULL.

Returns:

Pt_TRUE: The file was opened and is now closed.
Pt_FALSE: No file was open, cx was NULL, or there was an error updating the file to reflect the new configuration.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No