#include <VXIlog.h>
Public Attributes | |
VXIint32(* | GetVersion )(void) |
Get the VXI interface version implemented. | |
const VXIchar *(* | GetImplementationName )(void) |
Get the name of the implementation. | |
VXIlogResult(* | Error )(struct VXIlogInterface *pThis, const VXIchar *moduleName, VXIunsigned errorID, const VXIchar *format,...) |
Log an error Basic error reporting mechanism. | |
VXIlogResult(* | VError )(struct VXIlogInterface *pThis, const VXIchar *moduleName, VXIunsigned errorID, const VXIchar *format, va_list vargs) |
Log an error (va_list variant). | |
VXIlogResult(* | Diagnostic )(struct VXIlogInterface *pThis, VXIunsigned tagID, const VXIchar *subtag, const VXIchar *format,...) |
Log a diagnostic message. | |
VXIlogResult(* | VDiagnostic )(struct VXIlogInterface *pThis, VXIunsigned tagID, const VXIchar *subtag, const VXIchar *format, va_list vargs) |
Log a diagnostic message (va_list variant). | |
VXIbool(* | DiagnosticIsEnabled )(struct VXIlogInterface *pThis, VXIunsigned tagID) |
Query whether diagnostic logging is enabled. | |
VXIlogResult(* | Event )(struct VXIlogInterface *pThis, VXIunsigned eventID, const VXIchar *format,...) |
Log an event. | |
VXIlogResult(* | VEvent )(struct VXIlogInterface *pThis, VXIunsigned eventID, const VXIchar *format, va_list vargs) |
Log an event (va_list variant). | |
VXIlogResult(* | EventVector )(struct VXIlogInterface *pThis, VXIunsigned eventID, const VXIVector *keys, const VXIVector *values) |
Log an event (VXIVector variant). | |
VXIlogResult(* | ContentOpen )(struct VXIlogInterface *pThis, const VXIchar *moduleName, const VXIchar *contentType, VXIString **logKey, VXIString **logValue, VXIlogStream **stream) |
Open a handle to log (potentially large or binary) content. | |
VXIlogResult(* | ContentClose )(struct VXIlogInterface *pThis, VXIlogStream **stream) |
Close a stream for logging (potentially large or binary) content. | |
VXIlogResult(* | ContentWrite )(struct VXIlogInterface *pThis, const VXIbyte *buffer, VXIulong buflen, VXIulong *nwritten, VXIlogStream *stream) |
Write (potentially large or binary) content to a logging stream. |
|
Close a stream for logging (potentially large or binary) content. NOTE: This is only available as of version 1.1 of the VXIlogInterface, use LOG_CONTENT_METHODS_SUPPORTED( ) to determine availability. Close a content stream that was previously opened. Closing a NULL or previously closed stream will result in an error.
|
|
Open a handle to log (potentially large or binary) content. NOTE: This is only available as of version 1.1 of the VXIlogInterface, use LOG_CONTENT_METHODS_SUPPORTED( ) to determine availability. In situations where large blocks of data need to be logged and/or the data is binary, this method should be used to open a content logging stream. Data is written via ContentWrite( ), and the stream is then closed via ContentClose( ). The key/value pair returned by this method indicates the location of the logged data, and should be used to reference this content within error, event, and/or diagnostic messages.
|
|
Write (potentially large or binary) content to a logging stream. NOTE: This is only available as of version 1.1 of the VXIlogInterface, use LOG_CONTENT_METHODS_SUPPORTED( ) to determine availability. Write data to a content stream that was previously opened.
|
|
Log a diagnostic message. Basic diagnostic reporting mechanism. Diagnostic messages are reported by moduleName, tag id, subtag, a format, and a variable length argument list.
NOTE: Do NOT use C and S in the format string for inserting narrow character strings (char and char *) as supported by some compilers, as this is not portable and may result in system crashes on some UNIX variants if the VXIlog implementation uses the compiler supplied ...printf( ) family of functions for handling these variable argument lists.
|
|
Query whether diagnostic logging is enabled. NOTE: Diagnostic log messages are automatically filtered in a high-performance way by the Diagnostic method. This should only be used in the rare conditions when there is significant pre-processing work required to assemble the input parameters for Diagnostic( ), and thus it is best to suppress that performance impacting pre-processing as well.
|
|
Log an error Basic error reporting mechanism. Errors are reported by moduleName, error number, a format, and a varargs argument list. IMPORTANT: Error details are not free-form, they must be passed as a succession of key-value pairs, i.e. a string key followed by a value. For example, this format string and arguments is correct: L"siss", L"key1", 911, L"key2", L"value2"
While this one is incorrect (second key missing): L"sif", L"key1", 911, (float)22 / 7 Keys must always be specified by a s, and the key names must follow the rules for XML names as summarized at the top of this header. Values may be specified by the ANSI C defined format parameters for printf( ), including the ability to control string widths, number of decimals to output, padding etc. There are no restrictions on the variable values, it is the responsibility of the logging system to escape the variable values if required by the final output stream (such as output via XML). NOTE: Do NOT use C and S in the format string for inserting narrow character buffers (char and char *) as supported by some compilers, as this is not portable and may result in system crashes on some UNIX variants if the VXIlog implementation uses the compiler supplied printf( ) family of functions for handling these variable argument lists.
|
|
Log an event. Basic error reporting mechanism. Errors are reported by moduleName, error number, and with a varargs format. Event details are not free-form, they must be passed as a succession of key-value pairs, i.e. a string key followed by a value. See the description of the format parameter for <a=href="Error.html"> Error for a full explanation.
IMPORTANT: Event details are not free-form, they must be passed as a succession of key-value pairs, i.e. a string key followed by a value. See the description of the format parameter for Error for a full explanation.
|
|
Log an event (VXIVector variant). NOTE: This is only available as of version 1.1 of the VXIlogInterface, use LOG_EVENT_VECTOR_SUPPORTED( ) to determine availability. Same as Event , but a vector of keys and a vector of values is supplied as arguments to make it possible to build dynamic lists of key/value pairs for logging (such as event logging of recognition results)
|
|
Get the name of the implementation.
|
|
Get the VXI interface version implemented.
|
|
Log a diagnostic message (va_list variant). Same as Diagnostic, but a va_list is supplied as an argument instead of "..." in order to make it easy to layer convenience functions/classes for logging on top of this interface.
|
|
Log an error (va_list variant). Same as Error, but a va_list is supplied as an argument instead of "..." in order to make it easy to layer convenience functions/classes for logging on top of this interface.
|
|
Log an event (va_list variant). Same as Event , but a va_list is supplied as an argument instead of "..." in order to make it easy to layer convenience functions/classes for logging on top of this interface.
|