Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 2.46 KB

nf-objidl-ipipebyte-pull.md

File metadata and controls

79 lines (62 loc) · 2.46 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:objidl.IPipeByte.Pull
IPipeByte::Pull (objidl.h)
The IPipeByte::Pull method (objidl.h) retrieves data of the byte type from the pipe source.
IPipeByte interface [COM]
Pull method
IPipeByte.Pull
IPipeByte::Pull
Pull
Pull method [COM]
Pull method [COM]
IPipeByte interface
_com_ipipebyte_pull
com.ipipebyte_pull
objidlbase/IPipeByte::Pull
com\ipipebyte_pull.htm
com
07d4d4cd-de41-41bc-af71-ff12affcbbbe
08/12/2022
IPipeByte interface [COM],Pull method, IPipeByte.Pull, IPipeByte::Pull, Pull, Pull method [COM], Pull method [COM],IPipeByte interface, _com_ipipebyte_pull, com.ipipebyte_pull, objidlbase/IPipeByte::Pull
objidl.h
ObjIdl.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
ObjIdl.idl
Windows
19H1
IPipeByte::Pull
objidl/IPipeByte::Pull
c++
APIRef
kbSyntax
COM
objidlbase.h
IPipeByte.Pull

IPipeByte::Pull

-description

Retrieves data of the byte type from the pipe source.

-parameters

-param buf [out]

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.

-param cRequest [in]

The number of bytes requested.

-param pcReturned [out]

The actual number of bytes returned.

-returns

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.

-see-also

IPipeByte