IWriteEngine2EventArgs::get_FreeSystemBuffer method (imapi2.h)

Article
10/13/2021

Retrieves the number of unused bytes in the internal data buffer that is used for writing to disc.

Syntax

HRESULT get_FreeSystemBuffer(
  [out] LONG *value
);

Parameters

[out] value

Size, in bytes, of the unused portion of the internal data buffer that is used for writing to disc.

Return value

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code	Description
E_POINTER	Pointer is not valid. Value: 0x80004003

Remarks

This method returns the same value as if you subtracted IWriteEngine2EventArgs::get_UsedSystemBuffer from IWriteEngine2EventArgs::get_TotalSystemBuffer.

Requirements

Requirement	Value
Minimum supported client	Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imapi2.h