Edit

Share via

AllJoynSendToBus function (msajtransport.h)

  • Article

Sends data to the bus via named pipe. The caller of this API is responsible to check if the bytesTransferred is less than the
requested bytes and call this API again to resend the rest of the data.

When the named pipe outBufferSize is less than the bytesToWrite, writing to named pipe is returning TRUE and bytesTransferred == 0, rather than returning TRUE and transferring as much as possible.

Syntax

BOOL AllJoynSendToBus(
  [in]            HANDLE     connectedBusHandle,
  [in]            const VOID *buffer,
  [in]            DWORD      bytesToWrite,
  [out, optional] PDWORD     bytesTransferred,
  [in, out]       PVOID      reserved
);

Parameters

[in] connectedBusHandle

Pipe handle.

[in] buffer

Input data buffer.

[in] bytesToWrite

Number of bytes to send.

[out, optional] bytesTransferred

Number of bytes written.

[in, out] reserved

May be used in a future version as OVERLAPPED address. Currently must be NULL.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Requirements

Requirement Value
Minimum supported client Windows 10 [desktop apps | UWP apps]
Minimum supported server Windows Server 2016 [desktop apps | UWP apps]
Target Platform Windows
Header msajtransport.h
Library MSAJApi.lib
DLL MSAJApi.dll