IsPropVariantString function (propvarutil.h)

Specifies whether a specified PROPVARIANT structure is a string type.

Syntax

BOOL IsPropVariantString(
  [in] REFPROPVARIANT propvar
);

Parameters

[in] propvar

Type: REFPROPVARIANT

Reference to the PROPVARIANT structure.

Return value

Type: BOOL

Returns TRUE if propvar is a VT_LPWSTR or VT_BSTR PROPVARIANT; otherwise, FALSE.

Remarks

If this function returns TRUE, the PROPVARIANT structure referenced in propvar contains a Unicode string. To retrieve it, call PropVariantToStringWithDefault as shown here:

PropVariantToStringWithDefault(propvar, NULL);

This is an inline function, with its source code provided in the header. It is not included in any .dll or .lib file.

Requirements