IStream::SetSize method

The SetSize method changes the size of the stream object.

Syntax

HRESULT SetSize(
  ULARGE_INTEGER libNewSize
);

Parameters

libNewSize

Specifies the new size, in bytes, of the stream.

Return value

This method can return one of these values.

Remarks

IStream::SetSize changes the size of the stream object. Call this method to preallocate space for the stream. If the libNewSize parameter is larger than the current stream size, the stream is extended to the indicated size by filling the intervening space with bytes of undefined value. This operation is similar to the ISequentialStream::Write method if the seek pointer is past the current end of the stream.

If the libNewSize parameter is smaller than the current stream, the stream is truncated to the indicated size.

The seek pointer is not affected by the change in stream size.

Calling IStream::SetSize can be an effective way to obtain a large chunk of contiguous space.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header objidl.h
Library Uuid.lib
DLL Ole32.dll

See also

ISequentialStream::Write

IStream

IStream - Compound File Implementation