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

IDSSRequest Interface Reference

Inherited by IDSSRequest2.

List of all members.


Detailed Description

A DSS Request object records the specification for a job that could be executed on a DSS Server.

Before MicroStrategy 7.1: A DSS Request consists of a DSS Script and an executor (a DSS User). DSS Script describes a program DSS Server executes. The executor represents the user on whose behalf the server runs the request.
After MicroStrategy 7.1: The executor will not be used. The request has a script property as before. The script has a statement, also as before. Earlier, there was the possibility of this statement being a simple statement or pointing to a set of substatements, which in turn could be either simple statements or could have substatements members. This allowed for a very generic structure. But we have made some assumptions about this structure for scalability reasons. The statement in the script object is not going to be a simple statement but will have a substatements member. The substatements will have to be a collection of simple statements.


Public Member Functions

HRESULT Executor ([in] IDSSUser *pUser)
 The executor the current request is for.
HRESULT Executor ([out, retval] IDSSUser ppUser)
 The executor the current request is for.
HRESULT Info ([out, retval] IDSSObjectInfo ppInfo)
 The standard IDSSObjectInfo property for name, ID, ACL, etc.
HRESULT Script ([out, retval] IDSSScript ppScript)
 The content of the current request.


Member Function Documentation

HRESULT IDSSRequest::Executor [in] IDSSUser pUser  ) 
 

The executor the current request is for.

Executor is a user object. It is the user on whose behalf the server will execute the current request. Not used after MicroStrategy 7.1.

Parameters:
pUser The executor
Returns:
Usual COM result code:
  • S_OK
  • E_INVALIDARG pExecutor is NULL
  • E_POINTER The memory of ppExecutor is not allocated before calling the get method

HRESULT IDSSRequest::Executor [out, retval] IDSSUser   ppUser  ) 
 

The executor the current request is for.

Executor is a user object. It is the user on whose behalf the server will execute the current request. Not used after MicroStrategy 7.1.

Parameters:
ppUser The pointer to the IDSSUser interface of the executor
Returns:
Usual COM result code:
  • S_OK
  • E_INVALIDARG pExecutor is NULL
  • E_POINTER The memory of ppExecutor is not allocated before calling the get method

HRESULT IDSSRequest::Info [out, retval] IDSSObjectInfo   ppInfo  ) 
 

The standard IDSSObjectInfo property for name, ID, ACL, etc.

Standard IDSSObjectInfo property of a first class object. It contains the ID, Name, and PropertySet of a DSS Script.

Parameters:
ppInfo The pointer to the IDSSObjectInfo interface of this request object
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of ppInfo is not allocated before calling the get method

HRESULT IDSSRequest::Script [out, retval] IDSSScript   ppScript  ) 
 

The content of the current request.

This read-only property is the script of the current request. A script is the content of the request; it tells the server what to do to fulfill the request.

Parameters:
ppScript The pointer to the IDSSScript interface of the script
Returns:
Usual COM result code:
  • S_OK
  • E_POINTER The memory of ppScript is not allocated before calling the get method


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