Windows Media Format SDK banner art
PreviousNext

IWMDMLogger::LogString

The LogString method logs a string to the current log file. A carriage return and line feed are added to each log entry.

Syntax

HRESULT LogString(
  DWORD  dwFlags,
  LPSTR  pszSrcName,
  LPSTR  pszLog
);

Parameters

  dwFlags

[in]  Specifies flags that control the way a string is logged. This parameter is a combination of one or more of the following values.

Flag Description
WMDM_LOG_SEV_INFO Tag the log entry as informational.
WMDM_LOG_SEV_WARN Tag the log entry as a warning.
WMDM_LOG_SEV_ERROR Tag the log entry as an error.
WMDM_LOG_NOTIMESTAMP Do not include a time stamp on the log entry. Time stamps are in ISO format minus the time zone information.

  pszSrcName

[in]  Pointer to a string containing the name of the module that is making the log entry. This parameter can be NULL.

  pszLog

[in]  Pointer to a string to be copied to the log. This parameter can be NULL.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Description
E_INVALIDARG A parameter is invalid.
E_ACCESSDENIED An error occurred while accessing the log file.
E_OUTOFMEMORY There is not enough memory to complete this logging operation.
E_ABORT The method timed out while trying to get exclusive access to the log file.
E_FAIL An unspecified error occurred.

See Also

PreviousNext


© 1999 Microsoft Corporation. All rights reserved.