Share via

PFN_GETDEVCFG (Compact 2013)

  • Article

10/16/2014

This function is used by kernel independent transport layer (KITL) to get the device-side KITL transport configuration information.

Syntax

typedef BOOL (* PFN_GETDEVCFG) (
    LPBYTE pbBuffer,
   PUSHORT pcbBuffer
);

Parameters

  • pbBuffer
    [in] Pointer to a buffer used to receive the data from the transport.
  • pcbBuffer
    [in] Set to the size of the buffer when called and then reset by the KITL transport to the size of data written to the pbBufferbuffer.

Return Value

Returns true if data is added to the buffer; otherwise, false.

If the transport has no device configuration information, such as for a serial port, set pcbBuffer to zero and return true.

Remarks

You implement a function of this type and assign it to the pfnGetDevCfg member of the KITLTRANSPORT structure during your Board Support Package (BSP) KITL initialization. For an example of the implementation of this function, see the KitlEthGetDevCfg 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.

For Ethernet transport, use EDBG_ADDR to provide the IP, media access control (MAC) address, and port of the device.

For serial KITL, which is directly connected, this function is not required, but Kitl.dll must provide a stub function for it.

Requirements

Header

kitl.h

Library

Kitl.lib

See Also

Reference

Required KITL Functions
KITLTRANSPORT