IByteBuffer::Clone method

[The Clone method is available for use in the operating systems specified in the Requirements section. It is not available for use in Windows Server 2003 with Service Pack 1 (SP1) and later, Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The IStream interface provides similar functionality.]

The Clone method creates a new object with its own seek pointer that references the same bytes as the original IByteBuffer object.

Syntax

HRESULT Clone(
  [out] LPBYTEBUFFER *ppByteBuffer
);

Parameters

ppByteBuffer [out]

When successful, points to the location of an IByteBuffer pointer to the new stream object. When you have finished using the IByteBuffer pointer, release it by calling the IUnknown::Release function. If an error occurs, this parameter is NULL.

Return value

The return value is an HRESULT. A value of S_OK indicates the call was successful.

Remarks

This method creates a new stream object for accessing the same bytes but using a separate seek pointer. The new stream object sees the same data as the source stream object. Changes written to one object are immediately visible in the other. Range locking is shared between the stream objects.

The initial setting of the seek pointer in the cloned stream instance is the same as the current setting of the seek pointer in the original stream at the time of the clone operation.

Examples

The following example shows cloning the IByteBuffer interface.

HRESULT  hr;

// Clone the buffer.
hr = pIByteBuff->Clone(&pIByteClone);
if (FAILED(hr))
  printf("Failed IByteBuffer::Clone\n");

Requirements