System.VarUtils.VariantCopyInd

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function VariantCopyInd; external oleaut name 'VariantCopyInd';

C++

extern "C" HRESULT __stdcall VariantCopyInd(TVarData &Dest, const TVarData &Source);

Properties

Type Visibility Source Unit Parent
function external public
System.VarUtils.pas
System.VarUtils.hpp
System.VarUtils System.VarUtils

Description

Clears the destination variant and makes a copy of the source variant, including the case when the source is of type varByRef.

Use VariantCopyInd to copy the source variant given through Source to the destination variant denoted by Dest, after clearing up Dest using a call to VariantClear.

In the case when the source is of type varByRef, VariantCopyInd performs the indirection and copies the correct information.

The possible return values of VariantCopyInd are given in the following table, together with their meaning:


Value Meaning

VAR_OK

The operation was completed successfully.

VAR_BADVARTYPE

The variant type of the input parameter is not valid.

VAR_INVALIDARG

Either one of the arguments is invalid.

VAR_OUTOFMEMORY

There is not enough memory to complete the operation.

VAR_UNEXPECTED

An unexpected error occurred.

VAR_EXCEPTION

The application raised an exception.


See Also