IByteBuffer::Stat method

[The Stat 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 Stat method retrieves statistical information from the stream object.

Syntax

HRESULT Stat(
  [out] LPSTATSTRUCT pstatstg,
  [in]  LONG         grfStatFlag
);

Parameters

pstatstg [out]

Points to a STATSTRUCT structure where this method places information about this stream object. This pointer is NULL if an error occurs.

grfStatFlag [in]

Specifies that this method does not return some of the fields in the STATSTRUCT structure, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration

Return value

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

Remarks

The IByteBuffer::Stat method retrieves a pointer to the STATSTRUCT structure that contains information about this open stream.

Examples

The following example shows retrieving statistical information from the stream.

STATSTRUCT  statstr;
HRESULT     hr;

// Retrieve the statistical information.
hr = pIByteBuff->Stat(&statstr,
                      STATFLAG_DEFAULT);
if (FAILED(hr))
  printf("Failed IByteBuffer::Stat\n");
else
  // Use statstr as needed.

Requirements