WICMapSchemaToName function (wincodec.h)

Article
10/21/2021

Obtains the name associated with a given schema.

Syntax

HRESULT WICMapSchemaToName(
  [in]      REFGUID guidMetadataFormat,
  [in]      LPWSTR  pwzSchema,
  [in]      UINT    cchName,
  [in, out] WCHAR   *wzName,
  [out]     UINT    *pcchActual
);

Parameters

[in] guidMetadataFormat

Type: REFGUID

The metadata format GUID.

[in] pwzSchema

Type: LPWSTR

The URI string of the schema for which the name is to be retrieved.

[in] cchName

Type: UINT

The size of the wzName buffer.

[in, out] wzName

Type: WCHAR*

A pointer to a buffer that receives the schema's name.

To obtain the required buffer size, call WICMapSchemaToName with cchName set to 0 and wzName set to NULL.

[out] pcchActual

Type: UINT

The actual buffer size needed to retrieve the entire schema name.

Return value

Type: HRESULT

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

Remarks

You can extend the schema name mapping by adding to the following registry key:

HKEY_CLASSES_ROOT
   CLSID
      {FAE3D380-FEA4-4623-8C75-C6B61110B681}
         Schemas
            BB5ACC38-F216-4CEC-A6C5-5F6E739763A9
               ...

For more information, see How to Write a WIC-Enabled Codec.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	wincodec.h
Library	Windowscodecs.lib
DLL	Windowscodecs.dll

Share via