TransportEncode

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/27/2008

This function is used to encapsulate data with a transport-specific header and a trailer block. If required, the header and trailer block are determined by the OEM and the transport.

Syntax

BOOL TransportEncode(
  LPBYTE pbFrame,
  USHORT cbData
);

Parameters

• pbFrame
  [in] Pointer to a complete frame.

• cbData
  [in] Count of the number of bytes that make up the data portion of the frame.

Return Value

If the encoding succeeds, TRUE is returned; otherwise, FALSE is returned.

Remarks

Given a frame and the size of the data, the OEM will encode the frame to be suitable for the current transport. Assign TransportEncode to the pfnEncode member of KITLTRANSPORT during OEMKitlInit.

The frame is guaranteed to be large enough for the transport header and transport trailer based on the OEM's size requests in the Kitl.FrmHdrSize and Kitl.FrmTlrSize fields of KITLTRANSPORT.

The frame is passed with the data located following the frame header. The OEM simply needs to fill the frame header and trailer, if a trailer is required.

Requirements

See Also

Reference

KITLTRANSPORT
OEMKitlInit