IWMDMLogger::LogString (deprecated)

  • Article
banner art

This is preliminary documentation and subject to change.

This topic documents a feature of the Windows Media Device Manager SDK. We recommend that you migrate your application to use the Windows Portable Devices API. For more information, see the Windows Portable Devices SDK.

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]  Flags that control the way a string is logged. This parameter is a combination of one or more of the following values.

Value 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

The method returns an HRESULT. All the interface methods in Windows Media Device Manager can return any of the following classes of error codes:

  • Standard COM error codes
  • Windows error codes converted to HRESULT values
  • Windows Media Device Manager error codes

For an extensive list of possible error codes, see Error Codes.

Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK The method succeeded.
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.

Example Code

// Send a startup message.
hr = m_pLogger->LogString(WMDM_LOG_SEV_INFO, NULL, "Application started.");

Requirements

Header: Defined in wmdmlog.idl.

Library: mssachlp.lib

See Also