This topic has not yet been rated - Rate this topic

PropStgNameToFmtId function

Applies to: desktop apps | Metro style apps

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

Syntax

Copy

HRESULT PropStgNameToFmtId(
  __in   const LPOLESTR oszName,
  __out  FMTID *pfmtid
);

Parameters

oszName [in]: 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.
pfmtid [out]: 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:

S_OK: The format identifier of the property set was successfully returned.
STG_E_INVALIDNAME: The oszName parameter was invalid.

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