Administrative APIs

Functions
SYSINFO_API const wchar_t *	SysInfoDll_GetVersion (void)
	Call this function to retrieve the SysInfo DLL version. This function returns a pointer to constant characters (via use of a static buffer). Attempting to change the value(s) of constant characters is an error. No attempt should be made to free the character buffer returned by this function.
SYSINFO_API BOOL	SysInfoDll_StartLogging (LPWSTR lpszPath)
	Call this function to begin writing SysInfo log information into a file.
SYSINFO_API BOOL	SysInfoDll_StartLoggingExisting (FILE *fp)
	Call this function to begin writing SysInfo log information into an existng file managed by the calling application.
SYSINFO_API BOOL	SysInfoDll_StopLogging (void)
	Call this function to stop writing SysInfo log information.
SYSINFO_API BOOL	SysInfoDll_GetLastErrorString (LPWSTR lpszError, DWORD dwsize)
	Call this function to retrieve the last error as a string.

---

Function Documentation

SYSINFO_API const wchar_t* SysInfoDll_GetVersion

(

void

)

Call this function to retrieve the SysInfo DLL version. This function returns a pointer to constant characters (via use of a static buffer). Attempting to change the value(s) of constant characters is an error. No attempt should be made to free the character buffer returned by this function.

Returns:

SysInfo DLL version string

SYSINFO_API BOOL SysInfoDll_StartLogging

(

LPWSTR

lpszPath

)

Call this function to begin writing SysInfo log information into a file.

Parameters:

[in]

lpszPath

Directory path to store the log file.

Returns:

TRUE if successful, otherwise FALSE

SYSINFO_API BOOL SysInfoDll_StartLoggingExisting

(

FILE *

fp

)

Call this function to begin writing SysInfo log information into an existng file managed by the calling application.

Parameters:

[in]

fp

File pointer of an opened file to store the log file lines.

Returns:

TRUE if successful, otherwise FALSE

SYSINFO_API BOOL SysInfoDll_StopLogging

(

void

)

Call this function to stop writing SysInfo log information.

Returns:

TRUE if successful, otherwise FALSE

SYSINFO_API BOOL SysInfoDll_GetLastErrorString	(	LPWSTR	lpszError,
		DWORD	dwsize
	)

Call this function to retrieve the last error as a string.

Parameters:

[out]	lpszError	Pointer to a string to store the error.
[in]	dwsize	size of the lpszError string buffer.

Returns:

TRUE if successful, otherwise FALSE