Share via

IWMDMLogger::Enable (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 Enable method enables or disables logging. Logging is enabled by default.

Syntax

HRESULT Enable(
  BOOL  fEnable
);

Parameters

fEnable

[in]  Flag that enables logging if it is true and disables logging if it is false.

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_FAIL An unspecified error occurred.

Example Code

// Create logging object.
CoCreateInstance(CLSID_WMDMLogger, NULL, CLSCTX_ALL, __uuidof(IWMDMLogger), (void**)&m_pLogger);
BOOL enabled = FALSE;
hr = m_pLogger->IsEnabled(&enabled);
// TODO: Display a message indicating that logging is either enabled or disabled.
if(!enabled)
{
    if(m_pLogger->Enable(TRUE) != S_OK)
        m_pLogger = NULL;
}

Requirements

Header: Defined in wmdmlog.idl.

Library: mssachlp.lib

See Also