Share via

SetAllocatedSize (Windows Embedded CE 6.0)

  • Article

1/6/2010

This function sets the parameter data size for a command packet.

Syntax

RTFSUPP_API BOOL SetAllocatedSize(
  HPACKET hPacket,
  DWORD dwBytesRequested,
  DWORD *pBytesAllocated
);

Parameters

  • hPacket
    A handle to a command packet.

  • dwBytesRequested
    [in] The size of the parameter data buffer to reserve.

    This will be rounded up to the nearest 64kB block.

  • pBytesAllocated
    [out] The actual number of bytes allocated for the parameter data buffer.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

The Remote Tools Framework will try to reserve the memory specified rounded up to the nearest 64kB block, with a minimum of one block, so at least 64kB will be available.

The Remote Tools Framework does not lock memory until it is required. If pBytesReserved is not NULL, then this method returns the actual size reserved by the Remote Tools Framework.

Note that there is an 8-byte header on the command packet and each parameter you add to the command packet also uses an 8-byte header. The amount of space for data will depend on the number of parameters you add.

See Also

Reference

Remote Tools Framework Functions
Remote Tools Framework Reference