IDataFunctions_4_0::CloneObject Method [C++]

Article
11/12/2009

Use this method to clone a SimpleList or Dictionary object. This method performs a deep copy of the cloned object, so new memory is allocated for the clone.

Definition

[C++]

HRESULT IDataFunctions_4_0::CloneObject(IDispatch*pdispSource,
 IDispatch**ppdispDest);

[Visual Basic]

Function CloneObject(pdispSource As Object) As Object

Parameters

pdispSource[C++]
[in] A pointer to the IDispatch interface of the SimpleList or Dictionary object to be cloned.
pdispSource[Visual Basic]
A reference to the SimpleList or Dictionary object to be cloned.
ppdispDest[C++]
[out, retval] The address of a pointer used to return the IDispatch interface of the SimpleList or Dictionary object clone.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a reference to the SimpleList or Dictionary object clone.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

[C++] The ppdispDest parameter contains valid data only if the method completes successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.