SyncRead
Collapse the table of content
Expand the table of content

IAsyncReader::SyncRead method

The SyncRead method performs a synchronous read. The method blocks until the request is completed. The file positions and the buffer address do not have to be aligned. If the request is not aligned, the method performs a buffered read operation.

Syntax


HRESULT SyncRead(
  [in]  LONGLONG llPosition,
  [in]  LONG     lLength,
  [out] BYTE     *pBuffer
);

Parameters

llPosition [in]

Specifies the byte offset at which to begin reading. The method fails if this value is beyond the end of the file.

lLength [in]

Specifies the number of bytes to read.

pBuffer [out]

Pointer to a buffer that receives the data.

Return value

Returns an HRESULT value. Possible values include the following.

Return codeDescription
S_FALSE

Retrieved fewer bytes than requested. (Probably the end of the file was reached.)

S_OK

Success.

 

Remarks

This method works even if the filter is stopped.

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
IAsyncReader::SyncReadAligned

 

 

Community Additions

ADD
Show:
© 2016 Microsoft