Retrieves information about the QA plug-in.
PQAPluginDeclareInfo GetDeclareInfo()
None
Returns a pointer to a TQAPluginDeclareInfo object containing information about the QA plug-in.
Retrieves the name for this QA plug-in to be shown in the “Check Group” box in QA tab.
PWSTR GetDeclareName()
None
Returns a pointer to a string with the name of the QA plug-in.
Retrieves the handle of the first function in the QA plug-in.
DWORD GetFirstFunction()
None
Returns a handle for the first QA plug-in function. This handle will be later used to refer to this specific function during the QA pass.
Notifies the function QA plug-in that no more segments will be processed so it can perform any postprocess if needed, and returns the first of the errors that have to be notified in the QA tab.
PQAPluginResult GetFirstResult(DWORD aHandle)
aHandle: Function handle as obtained with GetFirstFunction and GetNextFunction.
Returns a pointer to a TQAPluginResult structure if an error has to be notified or NULL if there are not process errors left.
This function involves two actions:
Retrieves the name of a specific function of the QA plug-in.
PSTR GetFunctionName(DWORD aHandle)
aHandle: Function handle as obtained with GetFirstFunction and GetNextFunction.
Returns a string with the function name assigned to aHandle. ApSIC Xbench will display this string in the “List of Checks” box in the QA tab.
Retrieves the handle of the next function contained in the QA plug-in.
DWORD GetNextFunction()
None
Returns a handle for the next QA plug-in function or zero if no more functions are present.
After calling GetFirstFunction to obtain the handle for the first function, ApSIC Xbench will keep calling GetNextFunction until the result value is 0.
Retrieves the next error that must be reported on the QA tab.
PQAPluginResult GetNextResult(DWORD aHandle)
aHandle: Function handle as obtained with GetFirstFunction and GetNextFunction.
Returns a pointer to a TQAPluginResult structure if an error has to be notified or NULL if there are no errors left.
If the call to GetFirstResult does not return NULL, ApSIC Xbench will keep calling GetNextResult until NULL is returned.
Notifies the function that a new QA process is being launched and it should initialize.
void ProcessBegin(DWORD aHandle, PQAFunctionParams aParams)
aHandle: Function handle as obtained with GetFirstFunction and GetNextFunction.
aParams: (currently ignored) Optional parameters to be used by the function. Should be NULL.
None
ApSIC Xbench will call this function for every function QA plug-in that will be checked, but not for those that the user has manually disabled in the QA tab, so it should NOT be assumed that ProcessBegin has been called for other functions in the same QA plug-in.
Notifies the function that the QA process has finished and all allocated resources should be freed.
void ProcessEnd(DWORD aHandle)
aHandle: Function handle as obtained with GetFirstFunction and GetNextFunction.
None
Provides the function QA plug-in with a segment to be checked or stored in working structures.
PQAPluginResult ProcessSegment(DWORD aHandle, TQASegmentInfo aSegInfo)
aHandle: Function handle as obtained with GetFirstFunction and GetNextFunction.
aSegInfo: Structure with information about the segment to be checked.
Returns a pointer to a TQAPluginResult structure if an error has been found in this segment or NULL if nothing has to be notified.
### Comments There are two ways of notifying ApSIC Xbench about errors in segments: you can either return the value in ProcessSegment or use GetFirstResult and GetNextResult to return the list of errors at the end of the QA check. If you want to use the later method you can simply return NULL as the result for ProcessSegment.
The Options field of TQAPluginResult structure will be ignored and can be NULL.
Sets a filename for the QA plug-in to be used as a configuration file.
void SetConfigFile(PSTR aFile)
aFile: Filename to be used by the QA plug-in as a configuration file.
None
This function allows ApSIC Xbench to provide a filename that the QA plug-in may use for storing and retrieving some configuration values, so the QA plug-in does not need to use a hardcoded filename or guess an appropriate file path.
Currently ApSIC Xbench does not call this function but it must be exported by the QA plug-in anyway.