IUIRibbon::LoadSettingsFromStream method (uiribbon.h)

Reads ribbon settings from a binary stream.

Syntax

HRESULT LoadSettingsFromStream(
  IStream *pStream
);

Parameters

pStream

Type: IStream*

Pointer to an IStream object.

Return value

Type: HRESULT

Returns S_OK if successful, or E_FAIL if the format or content of the serialized stream is empty or cannot be verified by the Ribbon framework.

Remarks

The stream is supplied by the host application.

If the Windows Ribbon framework is unable to load a valid stream, the default ribbon layout is rendered instead.

The LoadSettingsFromStream method is useful for persisting ribbon state, such as Quick Access Toolbar (QAT) items, across application instances.

Requirements

   
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header uiribbon.h
DLL Mshtml.dll

See also

IUIRibbon

IUIRibbon::SaveSettingsToStream

Persisting Ribbon State

Windows Ribbon Framework Samples