IPersistMoniker::Load method

Loads the object from its persistent state as indicated by a supplied moniker.

Syntax

HRESULT Load(
  [in] BOOL     fFullyAvailable,
  [in] IMoniker *pimkName,
  [in] LPBC     pibc,
  [in] DWORD    grfMode
);

Parameters

• fFullyAvailable [in]
  A Boolean value that indicates if the data referred to by the moniker has been loaded one time. If TRUE, the subsequent binding to the moniker is synchronous. If FALSE, an asynchronous bind operation is launched.

• pimkName [in]
  The address of the IMoniker interface that references the persistent state for the object to be loaded.

• pibc [in]
  The address of the IBindCtx interface for the bind context to be used for any moniker binding during this method.

• grfMode [in]
  An unsigned long integer value that contains a combination of values from the STGM Constants enumeration, which indicates the access mode to use when binding to the persistent state. The IPersistMoniker::Load method can treat this value as a suggestion, adding more restrictive permissions, if necessary. If grfMode is zero, the implementation binds to the persistent state using default permissions.

Return value

Returns S_OK if the object was successfully loaded, or E_INVALIDARG if one or more parameters are invalid.

Remarks

Typically, the object immediately binds to its persistent state through a call to the source moniker's IMoniker::BindToStorage method, by requesting either the IStream interface or the IStorage interface.

Requirements

See also

IPersistMoniker