Skip to content

Latest commit

 

History

History
81 lines (65 loc) · 2.74 KB

nf-shlwapi-istream_size.md

File metadata and controls

81 lines (65 loc) · 2.74 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:shlwapi.IStream_Size
IStream_Size function (shlwapi.h)
Retrieves the size, in bytes, of a specified stream.
IStream_Size
IStream_Size function [Windows Shell]
_win32_IStream_Size
shell.IStream_Size
shlwapi/IStream_Size
shell\IStream_Size.htm
shell
93c7c24d-6431-4859-b0b8-b36392bc5108
12/05/2018
IStream_Size, IStream_Size function [Windows Shell], _win32_IStream_Size, shell.IStream_Size, shlwapi/IStream_Size
shlwapi.h
Windows
Windows 2000 Professional, Windows XP [desktop apps only]
Windows 2000 Server, Windows Server 2003 [desktop apps only]
Shlwapi.dll (version 5.0 or later)
Windows
19H1
IStream_Size
shlwapi/IStream_Size
c++
APIRef
kbSyntax
DllExport
Shlwapi.dll
API-MS-Win-DownLevel-shlwapi-l2-1-0.dll
ShCore.dll
API-MS-Win-DownLevel-shlwapi-l2-1-1.dll
API-MS-Win-ShCore-stream-l1-1-0.dll
IStream_Size

IStream_Size function

-description

Retrieves the size, in bytes, of a specified stream.

-parameters

-param pstm [in]

Type: IStream*

A pointer to the IStream interface of the stream whose size is to be determined.

-param pui [out]

Type: ULARGE_INTEGER*

A pointer to a ULARGE_INTEGER structure to receive the size of the stream.

-returns

Type: HRESULT

Returns S_OK on success or a COM failure code otherwise. See IStream::Stat for further discussion of possible error codes.

-remarks

This function gets the size of the stream by calling the specified stream object's IStream::Stat method. It then copies the value of the cbSize member of the STATSTG structure returned by IStream::Stat to the ULARGE_INTEGER structure pointed to by pui. If the function fails, the contents of the ULARGE_INTEGER structure are undefined.