PdhVbUpdateLog function

The PdhVbUpdateLog function function updates the current query and writes new data to the log file. This function calls PdhUpdateLog.

Important

The function that this topic describes may be altered or unavailable in the future. Instead, Microsoft recommends that you use the functions described in Performance Counters Functions.

Function PdhVbUpdateLog( _ ByVal hLog As PDH_HLOG, _ ByVal szUserString As LPCTSTR _ )

Parameters

hLog [in]

Handle to the log file to be updated. This handle is returned by the PdhVbOpenLog function.

szUserString [in]

Pointer to a string that specifies the data to be added to the log file. This is generally used for comments within the log file.

Return value

If the function succeeds, it returns 0.

If the function fails, the return value is a system error code or a PDH error code. The following are possible values.

Return code	Description
PDH_INSUFFICIENT_BUFFER	The requested data is larger than the buffer supplied. Unable to return the requested data.
PDH_INVALID_ARGUMENT	One or more of the string buffers is not the correct size.
PDH_INVALID_HANDLE	The handle is not a valid PDH object.
PDH_LOG_FILE_OPEN_ERROR	Unable to open the specified log file.
PDH_FILE_NOT_FOUND	Unable to find the specified file.

Remarks

There must be a currently opened query, and the desired counters must be added to it before this function is called.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Library	Pdh.lib
DLL	Pdh.dll

See also

PdhUpdateLog

PdhVbGetLogFileSize

PdhVbOpenLog