IStream_Reset

This function resets a stream’s seek pointer to zero.

Declaration

HRESULT IStream_Reset (LPSTREAM pstm);

Parameters

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

Return Value

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

Behaviour

The function calls the given stream’s Seek method to set zero as the new seek pointer.

Availability

The IStream_Reset function is exported from SHLWAPI as ordinal 213 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.