GetCanonicalName

IPropertyDescription::GetCanonicalName method

Gets the case-sensitive name by which a property is known to the system, regardless of its localized name.

Syntax


HRESULT GetCanonicalName(
  [out] LPWSTR *ppszName
);

Parameters

ppszName [out]

Type: LPWSTR*

When this method returns, contains the address of a pointer to the property's canonical name as a null-terminated Unicode string.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The information retrieved by this method comes from the name attribute of the propertyDescription element in the property's .propdesc file.

It is the responsibility of the calling application to use CoTaskMemFree to release the string referred to by ppszName when it is no longer needed.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Propsys.h

IDL

Propsys.idl

See also

IPropertyDescription
Property Description Schema

 

 

Show:
© 2016 Microsoft