ClearPropVariantArray function

Frees the memory and references used by an array of PROPVARIANT structures stored in an array.

Syntax

VOID ClearPropVariantArray(
  _In_ PROPVARIANT *rgPropVar,
  _In_ UINT        cVars
);

Parameters

rgPropVar [in]

Type: PROPVARIANT*

Array of PROPVARIANT structures to free.

cVars [in]

Type: UINT

The number of elements in the array specified by rgPropVar.

Return value

No return value.

Remarks

This function releases the memory and references held by each structure in the array before setting the structures to zero.

This function performs the same action as FreePropVariantArray, but FreePropVariantArray returns an HRESULT.

Examples

The following example, to be included as part of a larger program, demonstrates how to use ClearPropVariantArray

// PROPVARIANT rgpropvar[5];
// Assume all 5 propvariants are initialized and valid.

ClearPropVariantArray(rgpropvar, ARRAYSIZE(rgpropvar));

Requirements

See also

ClearVariantArray