PFN_ENCODE (Windows Embedded CE 6.0)

1/5/2010

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. You implement a function of this type and assign it to the pfnEncode member of KITLTRANSPORT during your board support package (BSP) KITL initialization. For an example of the implementation of this function, see the KitlEthEncode function in %_WINCEROOT%\Platform\Common\Src\Common\Kitl\Kitleth.c. If you are using the common KITL library in conjunction with Ethernet or serial transport, this function is already implemented for you.

Requirements

See Also

Reference

Required KITL Functions
KITLTRANSPORT
OEMKitlInit