Edit

Share via

IPropertyDescription::IsValueCanonical method (propsys.h)

  • Article

Gets a value that indicates whether a property is canonical according to the definition of the property description.

Syntax

HRESULT IsValueCanonical(
  [in] REFPROPVARIANT propvar
);

Parameters

[in] propvar

Type: REFPROPVARIANT

A reference to a PROPVARIANT structure that contains the type and value of the property.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 The value is canonical.
S_FALSE
 The value is not canonical.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header propsys.h