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

IDSSDocumentSource Interface Reference

Inherited by IDSSDocumentSource2.

List of all members.

Detailed Description

This interface is used to instruct the Document server to create a DocumentInstance and execute a Document.


Public Member Functions

HRESULT Execute ([in] IDSSDocumentInstance *pDocumentInstance,[in, optional] EnumDSSDocumentActions Actions,[in, optional] EnumDSSDocumentFlags Flags,[in, optional] IDSSUserRuntime *pUserRuntime,[in, optional] Int32 Cookie,[in, optional] Int32 UserData)
 This method performs one or more stages of the execution process in a single call.
HRESULT ExecuteDefinition ([in] IDSSDocumentDefinition *pDocumentDefinition,[in, optional] EnumDSSDocumentActions Actions,[in, optional] EnumDSSDocumentFlags Flags,[in, optional] IDSSUserRuntime *pUserRuntime,[in, optional] Int32 Cookie,[in, optional] Int32 UserData,[out, retval] IDSSDocumentInstance ppInstance)
 This method is a shorthand method.
HRESULT NewInstance ([in] IDSSDocumentDefinition *pDocumentDefinition,[in] IDSSResolution *pResolution,[in, optional] EnumDSSDocumentFlags Flags,[in, optional] IDSSUserRuntime *pUserRuntime,[out, retval] IDSSDocumentInstance ppInstance)
 This method constructs a new DocumentInstance based on the given Document definition.
HRESULT PromptResume ([in] IDSSDocumentInstance *pDocumentInstance,[in] IDSSResolution *pResolution,[in] IDSSUserRuntime *pUserRuntime,[in] Int32 Cookie)
 This method tells the server to resume execution following the answering of a prompt question.
HRESULT Session ([out, retval] IDSSSession ppSession)
 This property allows access to the session in which the Document server resides.

Member Function Documentation

HRESULT IDSSDocumentSource::Execute (  [in] IDSSDocumentInstance *  pDocumentInstance,
[in, optional] EnumDSSDocumentActions  Actions,
[in, optional] EnumDSSDocumentFlags  Flags,
[in, optional] IDSSUserRuntime *  pUserRuntime,
[in, optional] Int32  Cookie,
[in, optional] Int32  UserData
) 
 

This method performs one or more stages of the execution process in a single call.

This method performs one or more stages of the execution process in a single call. Only a Document instance is required. Other data objects are read from the Document instance, as they are needed. As usual the results will be written back to the same Document instance.

Since this method can be used to perform the resolution process, it is possible that resolution can occur when this method is called. This means that the caller should be prepared to handle autoprompts.
Parameters:
pDocumentInstance Contains the DocumentInstance to be executed.
Actions Bit vector of flags that indicate which actions are to be performed. These bits indicate which parts of the Document should be executed.
Flags Bit vector of flags that change the behavior of this call.
pUserRuntime The identity of the authenticated user making the request. NULL = use user that made this session.
Cookie Future Expansion
UserData A user data element that will be associated with the DocumentInstance.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDocumentSource::ExecuteDefinition (  [in] IDSSDocumentDefinition *  pDocumentDefinition,
[in, optional] EnumDSSDocumentActions  Actions,
[in, optional] EnumDSSDocumentFlags  Flags,
[in, optional] IDSSUserRuntime *  pUserRuntime,
[in, optional] Int32  Cookie,
[in, optional] Int32  UserData,
[out, retval] IDSSDocumentInstance   ppInstance
) 
 

This method is a shorthand method.

The result it returns is exactly the same as creating a new DocumentInstance from the given Document definition, and then immediately executing it with the given flags.. This method is a shorthand method. The result it returns is exactly the same as creating a new DocumentInstance from the given Document definition, and then immediately executing it with the given flags.

The downside of this method is that it does not allow us to modify the DocumentInstance before it is executed. Use Execute to execute an existing DocumentInstance a second time.
Parameters:
pDocumentDefinition The Document definition that describes the Document that we want to execute.
Actions Bit vector of flags that indicate which actions are to be performed. These bits indicate which parts of the Document should be executed.
Flags Bit vector of flags that change the behavior of this call.
pUserRuntime The identity of the authenticated user making the request. NULL = use user that made this session.
Cookie Future expansion
UserData A user data element that will be associated with the DocumentInstance.
ppInstance May not be NULL. The DocumentInstance constructed for this Document execution.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDocumentSource::NewInstance (  [in] IDSSDocumentDefinition *  pDocumentDefinition,
[in] IDSSResolution *  pResolution,
[in, optional] EnumDSSDocumentFlags  Flags,
[in, optional] IDSSUserRuntime *  pUserRuntime,
[out, retval] IDSSDocumentInstance   ppInstance
) 
 

This method constructs a new DocumentInstance based on the given Document definition.

The object is returned to the user.

This call does not execute the Document. Nor does it involve any network traffic, since the Document source only needs to make a local object.
Parameters:
pDocumentDefinition The definition for this Document instance.
pResolution May be NULL. If not NULL, then any autoprompt encountered in the Document's children reports is bound to the value recorded in this resolution object.
Flags Bit vector of flags that change the behavior of this call.
pUserRuntime The identity of the authenticated user making the request. NULL = use user that made this session.
ppInstance The DocumentInstance that was constructed.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDocumentSource::PromptResume (  [in] IDSSDocumentInstance *  pDocumentInstance,
[in] IDSSResolution *  pResolution,
[in] IDSSUserRuntime *  pUserRuntime,
[in] Int32  Cookie
) 
 

This method tells the server to resume execution following the answering of a prompt question.

Parameters:
pDocumentInstance The DocumentInstance being executed that encountered the prompt and should now be resumed.
pResolution The resolution that contains the answers to the prompt initially encountered.
pUserRuntime The identity of the authenticated user making the request. NULL = use user that made this session.
Cookie Future expansion
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSDocumentSource::Session (  [out, retval] IDSSSession   ppSession  ) 
 

This property allows access to the session in which the Document server resides.

This property allows access to the session in which the Document server resides.

Parameters:
ppSession The session in which the Document server resides.
Returns:
Usual COM result code:
  • S_OK

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