IByteBuffer::Commit method

[The Commit method is available for use in the operating systems specified in the Requirements section. It is not available for use in Windows Server 2003 with Service Pack 1 (SP1) and later, Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The IStream interface provides similar functionality.]

The Commit method ensures that any changes made to an object open in transacted mode are reflected in the parent storage.

Syntax

HRESULT Commit(
  [in] LONG grfCommitFlags
);

Parameters

grfCommitFlags [in]

Controls how the changes for the stream object are committed. For a definition of these values, see the STGC enumeration.

Return value

The return value is an HRESULT. A value of S_OK indicates the call was successful.

Remarks

This method ensures that changes to a stream object opened in transacted mode are reflected in the parent storage. Changes that have been made to the stream since it was opened or last committed are reflected to the parent storage object. If the parent is opened in transacted mode, the parent may still revert at a later time rolling back the changes to this stream object. The compound file implementation does not support opening streams in transacted mode, so this method has very little effect other than to flush memory buffers.

Examples

The following example shows committing changes to storage.

HRESULT  hr;

// Commit the buffer.
hr = pIByteBuff->Commit(STGC_DEFAULT | STGC_CONSOLIDATE);
if (FAILED(hr))
  printf("Failed IByteBuffer::Commit\n");

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
End of client support	Windows XP
End of server support	Windows Server 2003
Header	Scardssp.h
Type library	Scardssp.tlb
DLL	Scardssp.dll
IID	IID_IByteBuffer is defined as E126F8FE-A7AF-11D0-B88A-00C04FD424B9