PropStgNameToFmtId function (coml2api.h)

Article
02/22/2024

The PropStgNameToFmtId function converts a property set storage or stream name to its format identifier.

Syntax

HRESULT PropStgNameToFmtId(
  [in]  const LPOLESTR oszName,
  [out] FMTID          *pfmtid
);

Parameters

[in] oszName

A pointer to a null-terminated Unicode string that contains the stream name of a simple property set or the storage name of a nonsimple property set.

[out] pfmtid

A pointer to a FMTID variable that receives the format identifier of the property set specified by oszName.

Return value

This function supports the standard return value E_INVALIDARG as well as the following:

Remarks

The PropStgNameToFmtId function maps the stream name of a simple property set or the storage name of a nonsimple property set to its format identifier.

This function is useful in creating or opening a property set using the PROPSETFLAG_UNBUFFERED value with the StgCreatePropStg and StgOpenPropStg functions. For more information about PROPSETFLAG_UNBUFFERED, see PROPSETFLAG Constants.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps \| UWP apps]
Minimum supported server	Windows 2000 Server [desktop apps \| UWP apps]
Target Platform	Windows
Header	coml2api.h (include Propidl.h)
Library	Ole32.lib
DLL	Ole32.dll