IAsyncReader::Length method

The Length method retrieves the total length of the stream.

Syntax


HRESULT Length(
   LONGLONG *pTotal,
   LONGLONG *pAvailable
);

Parameters

pTotal

Pointer to a variable that receives the length of the stream, in bytes.

pAvailable

Pointer to a variable that receives the portion of the stream that is currently available, in bytes.

Return value

Returns an HRESULT value. Possible values include the following.

Return codeDescription
S_OK

Success.

VFW_S_ESTIMATED

The returned values are estimates; for example, if the file is being read over a network.

E_UNEXPECTED

The file is not open or no longer exists.

 

Remarks

For streams retrieved over a network, the entire stream may not be available at first. Read operations beyond the available length might block for a long period of time, until that portion of the stream becomes available.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

Error and Success Codes
IAsyncReader Interface

 

 

Show: