IeXdi2Generic::ReadClientScratchPad (Windows Embedded CE 6.0)

1/5/2010

This method enables a client to read back a memory block that contains miscellaneous data, or scratch pad, saved on the eXDI service by IeXdi2Generic::WriteClientScratchPad.

The scratch pad allocation is on per-client basis. Each client must provide a different GUID.

Syntax

HRESULT ReadClientScratchPad(
  [in] GUID guidClient,
  [out] DWORD* pdwBuffOutSize,
  [out, size_is(,* pdwBuffOutSize)] BYTE** ppbBufferOut
);

Parameters

• guidClient
  GUID that identifies client.

• pdwBuffOutSize
  Size of the scratch pad memory block.

• ppbBufferOut
  Pointer to memory block that contains the scratch pad. The buffer for this value is allocated by CoTaskMemAlloc.

Return Value

The following table shows return values for this method.

Remarks

To avoid resource leaking, use CoTaskMemFree to free the task memory used by the buffer that this function uses to return the scratch pad, pdwBuffOutSize and ppbBufferOut.

The following example shows how you might use CoTaskMemFree to release the memory held for the return buffers.

DWORD pdwBuffOutSize;
BYTE *ppbBufferOut;
HRESULT hr = pieXdi2Generic->ReadClientScratchPad (guidClient, &pdwBuffOutSize, &ppbBufferOut);
if (SUCCEEDED (hr))
{
    // Use scratch pad...
    CoTaskMemFree (ppbBufferOut);
    ppbBufferOut = 0;
}

Requirements

See Also

Reference

IeXdi2Generic
IeXDI2 Interfaces