Share via

IWMDMLogger::SetSizeParams (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 SetSizeParams method sets the current size parameters for the current log file.

Syntax

HRESULT SetSizeParams(
  DWORD  dwMaxSize,
  DWORD  dwShrinkToSize
);

Parameters

dwMaxSize

[in]  The approximate maximum size of the log file. The size of the log file is checked before each log entry is made. Therefore, the log file can grow bigger than the maximum size until the next log entry is made.

dwShrinkToSize

[in]  The approximate file size to which the log file should be reduced when the maximum log file size is reached. The log file is generally shrunk to a little smaller than this value so that the file is not split in the middle of a log entry.

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 return values include, but are not limited to, those in the following table.

Return code Description
S_OK The method succeeded.
E_ABORT The method timed out while trying to get exclusive access to the log file.
E_ACCESSDENIED An error occurred in accessing a file.
E_FAIL An unspecified error occurred.

Requirements

Header: Defined in wmdmlog.idl.

Library: mssachlp.lib

See Also