IStream_Size

This function gets the current size of a stream.

Declaration

HRESULT
IStream_Size (
    LPSTREAM pstm, 
    ULARGE_INTEGER *pui);

Parameters

The pstm argument provides the address of an IStream interface to some stream object.

The pui argument provides the address of a variable that is to receive the stream’s size.

Return Value

The function returns zero for success, else an error code.

Behaviour

The function calls the given stream’s Stat method and extracts the size.

Availability

The IStream_Size function is exported from SHLWAPI as ordinal 214 in version 5.00 and higher.

Though this function dates from as long ago as 1999, it was still not documented by Microsoft in the MSDN Library at least as late as the CD edition dated January 2004.

However, the function did eventually get documented, apparently later in 2004. This article now conforms to Microsoft’s nomenclature.