Edit

Share via

IPipeByte::Pull method (objidlbase.h)

  • Article

Retrieves data of the byte type from the pipe source.

Syntax

HRESULT Pull(
  [out] BYTE  *buf,
  [in]  ULONG cRequest,
  [out] ULONG *pcReturned
);

Parameters

[out] buf

A pointer to the memory buffer that receives the data. The buffer must be able to hold at least the number of bytes specified in cRequest.

[in] cRequest

The number of bytes requested.

[out] pcReturned

The actual number of bytes returned.

Return value

This method returns S_OK to indicate that the data was retrieved successfully.

Remarks

When the Pull method is called, data is requested from the provider of the pipe. The caller must provide a buffer that will hold at least the number of bytes specified in the cRequest parameter. The proxy will unmarshal the data into the provided buffer and set the number of bytes actually provided in pcReturned. The pcReturned parameter can be less than or equal to cRequest, but it will never be greater. When pcReturned is 0, it indicates that there is no more data.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header objidlbase.h (include ObjIdl.h)

See also

IPipeByte