IRAPIStream::GetRapiStat

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method gets the current value of the time-out for the IStream::Read method.

Syntax

HRESULT GetRapiStat(
  RAPISTREAMFLAG Flag,
  DWORD * pdwValue
);

Parameters

  • Flag
    [in] Used to get properties for the time-out. Currently, the only supported value is STREAM_TIMEOUT_READ.
  • pdwValue
    [out] Reference to the time-out value. The value is in seconds.

Return Value

  • S_OK
    The time-out value was retrieved successfully.
  • E_INVALIDARG
    The value of Flag was something other than STREAM_TIMEOUT_READ.
  • E_PENDING
    Asynchronous Storage only: Part or all of the stream's data is currently unavailable.
  • STG_E_ACCESSDENIED
    Insufficient access privileges for this stream object.

Remarks

IRAPIStream::GetRapiStat is modeled after IStream::Stat.

Requirements

Header rapi.h
Library rapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2000 and later, Smartphone 2002 and later

See Also

Reference

IRAPIStream
IRAPIStream::SetRapiStat

Other Resources

IStream::Read
IStream::Stat