Validate

Validate — Class used to manage Validate connections and process Validate Commands.

Synopsis

#include <prolinga/Validate.hpp>

class PlValidate
{
        public:
                PlValidate();
                ~PlValidate();
                void         validateOpen           (const char *configFileName);
                void         validateClose          (void);
                xmlDocPtr    executeCommand         (const xmlDocPtr validateRequest);
                ...
};
typedef PlValidate *PlValidatePtr;

Description

This class is used to connect to a Validate environment and executes a Validate Command.

Details

PlValidate::validateOpen ()

void       PlValidate::validateOpen           (const char *configFileName);

This function is called to initialize a connection to the Validate environment. The configuration file that is passed as an argument, is processed and the Language Definition File is opened. If the argument is set to NULL, the Validation default configuration file (etc/prolingavalcfg.xml) will be used.

Function PlValidate::validateClose must be called when access to the Validate is no longer needed in order to close all handles and to free memory.

configFileName :

the name or the Validate configuration file. If the argument is set to NULL, the Validate default configuration file (etc/prolingavalcfg.xml) will be used.

PlValidate::validateClose ()

void       PlValidate::validateClose           (void);

This function is called to close a connection to the Validate environment. All handles and allocated memory will be freed.

PlValidate::executeCommand ()

xmlDocPtr       PlValidate::executeCommand      (const xmlDocPtr validateRequest);

This function presents a Validate Command to the Validate processing engine. The command gets processed and a result returned. The returned XML document needs to be freed manually when it is no longer needed.

Returns :

the Validate Command response as a libxml2 XML document.

ProLinga