Edit

Share via

IPipeByte::Push method (objidl.h)

  • Article

Sends data of the byte type to the pipe source.

Syntax

HRESULT Push(
  [in] BYTE  *buf,
  [in] ULONG cSent
);

Parameters

[in] buf

A pointer to the memory buffer that holds the data to be sent.

[in] cSent

The number of bytes in the buffer.

Return value

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

Remarks

When the Push method is called, the data is being sent to the provider of the pipe. The caller fills the buffer with the data and then calls Push. The number of bytes being sent is specified in the cSent parameter. The caller is responsible for ensuring that the buffer is valid for the duration of the call.

When the last of the data has been pushed, the caller must do one last push of cSent equal to 0 to indicate that the data transfer is complete.

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 objidl.h (include ObjIdl.h)

See also

IPipeByte