Expand Minimize

IsPropVariantString function

Specifies whether a specified PROPVARIANT structure is a string type.

Syntax


BOOL IsPropVariantString(
  _In_  REFPROPVARIANT propvar
);

Parameters

propvar [in]

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

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propvarutil.h

 

 

Community Additions

ADD
Show:
© 2014 Microsoft