Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PropStgNameToFmtId function

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

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

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Header

Propidl.h

Library

Ole32.lib

DLL

Ole32.dll

See also

FmtIdToPropStgName
PROPSETFLAG Constants
StgCreatePropStg
StgOpenPropStg

 

 

Show:
© 2017 Microsoft