Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSObjectContextFactory Interface Reference

List of all members.

Detailed Description

Main interface on factory component used to make object context components.

This interface is exposed by the DSSObjectContextFactory coclass.

An initialized instance of the factory can be obtained from a session by asking for the component with role DssRoleObjectContextFactory.
See also:
IDSSSession::get_Component


Public Member Functions

HRESULT NewObjectContext ([in, defaultvalue(0)] EnumDSSContextFlags Flags,[in, defaultvalue(0)] IDSSUserRuntime *pRuntime,[out, retval] IDSSObjectContext ppContext)
 Get a new object context component for the current session.


Member Function Documentation

HRESULT IDSSObjectContextFactory::NewObjectContext [in, defaultvalue(0)] EnumDSSContextFlags  Flags,
[in, defaultvalue(0)] IDSSUserRuntime pRuntime,
[out, retval] IDSSObjectContext   ppContext
 

Get a new object context component for the current session.

Parameters:
pRuntime User for the object context. All source requests on this object context will be performed on behalf of this user. If this parameter is NULL then the context will use the session's default user.
Flags Modifiers for the operation.
  • DssContextFlagSupportLookUpByID Requests the contexts to build additional indexes so it supports look up by a plain ID. This flag should not be used unless the caller does intend to look up by ID. Note that look-up by ID will fail if the context contains two objects with the same ID.
  • DssContextFlagNoIndirectImport Requests that the context applies the DssContextFlagNoIndirectImport flag to all requests. This feature is useful since it will apply to requests made by one object in the context when trying to find another object.
ppContext A fresh object context component.
Returns:
Usual COM result code:
  • S_OK Operation was successful. The caller may assume *ppContext is non-NULL.
  • E_POINTER ppContext was NULL on entry.
  • DSSCOM_E_NOTINITIALIZED The factory has not been initialized with a session.


Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.