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

IDSSServerMessage Interface Reference

List of all members.

Detailed Description

IDSSServerMessage is the interface to an inbox message.


Public Member Functions

HRESULT ClientType ([in] EnumDSSApplicationType ClientType)
 Set the delivery mechanism of this request, for example, for agent, web, scheduler, or sysAdmin.
HRESULT ClientType ([out, retval] EnumDSSApplicationType *pClientType)
 Return the delivery mechanism of this request, for example, for agent, web, scheduler, or sysAdmin.
HRESULT FinishTime ([in] DATE aDate)
 Returns the time when the DSS server finished executing this user request.
HRESULT FinishTime ([out, retval] DATE *pDate)
 Returns the time when the DSS server finished executing this user request.
HRESULT FolderName ([in] BSTR FolderName)
 Set the name of the folder where the object resides.
HRESULT FolderName ([out, retval] BSTR *pFolderName)
 This is the name of the folder where the object resides.
HRESULT MsgCreationTime ([out, retval] DATE *pDate)
 Returns the creation time of this inbox message.
HRESULT MsgID ([out, retval] BSTR *pID)
 Returns the GUID of the inbox message.
HRESULT MsgModificationTime ([out, retval] DATE *pDate)
 Returns the time when the inbox message is last modified.
HRESULT MsgStatus ([in] EnumDSSInBoxMessageStatus Status)
 The status of the inbox message, for example, new or read.
HRESULT MsgStatus ([out, retval] EnumDSSInBoxMessageStatus *pStatus)
 The status of the inbox message, for example, new or read.
HRESULT MsgText ([in] BSTR MsgText)
 A text string of this inbox message.
HRESULT MsgText ([out, retval] BSTR *pMsgText)
 A text string of this inbox message.
HRESULT MsgTitle ([in] BSTR MsgTitle)
 Set the title of the message.
HRESULT MsgTitle ([out, retval] BSTR *pMsgTitle)
 Returns the title of the message.
HRESULT MsgType ([out, retval] EnumDSSInBoxMsgType *pMsgType)
 Returns the type of the inbox message, for example, general message, persistent message or active job message.
HRESULT ObjCreatorName ([in] BSTR CreatorName)
 This is the name of the creator of the object user submitted.
HRESULT ObjCreatorName ([out, retval] BSTR *pCreatorName)
 Returns the name of the creator who created this object.
HRESULT ObjDescription ([in] BSTR ObjDescription)
 This is a text description of the object user submitted.
HRESULT ObjDescription ([out, retval] BSTR *pObjDescription)
 Returns the description of the object submitted, for example, the description of a report or document.
HRESULT ObjectID ([out, retval] BSTR *pObjID)
 Returns the GUID of the object (that is, report or document) definition in the metadata.
HRESULT ParentMsgID ([out, retval] BSTR *pParentMsgID)
 The parent message ID of a child report message.
HRESULT ProjectID ([out, retval] BSTR *pProjectID)
 Returns the GUID of the project that the object belongs to.
HRESULT ProjectName ([in] BSTR ProjectName)
 Returns the name of the project that the object belongs to.
HRESULT ProjectName ([out, retval] BSTR *pProjectName)
 Returns the name of the project that the object belongs to.
HRESULT RqstStatus ([in] EnumDSSUserRequestStatus aRqstStatus)
 Set the status of this user request, for example, report result ready, job execution or error.
HRESULT RqstStatus ([out, retval] EnumDSSUserRequestStatus *pRqstStatus)
 Returns the status of this user request, for example, report result ready, job execution or error.
HRESULT RqstType ([in] EnumDSSUserRequestType RqstType)
 Get the type of the object the user has submitted, for example, a report, a document, or a workbook.
HRESULT RqstType ([out, retval] EnumDSSUserRequestType *pRqstType)
 Returns the type of the object the user has submitted, for example, a report, a document, or a workbook.
HRESULT StartTime ([in] DATE aDate)
 Returns the time when the user request started to be processed by the DSS server.
HRESULT StartTime ([out, retval] DATE *pDate)
 Returns the time when the user request started to be processed by the DSS server.

Member Function Documentation

HRESULT IDSSServerMessage::ClientType (  [in] EnumDSSApplicationType  ClientType  ) 
 

Set the delivery mechanism of this request, for example, for agent, web, scheduler, or sysAdmin.

This is the type of client application from which this user request is submitted, such as from Web, Agent, Scheduler or SysAdmin. We have the following types:

  • DssClientTypeReserved Not used.
  • DssClientTypeAgent 3-tier client except for scheduler.
  • DssClientTypeWeb 4-tier client.
  • DssClientTypeScheduler 3-tier scheduler.
  • DssClientTypeCustomApp Custom application.
  • DssClientTypeSysAdmin Not used.
    Parameters:
    ClientType The type of the client application where this user request came from.
    Returns:
    Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ClientType (  [out, retval] EnumDSSApplicationType *  pClientType  ) 
 

Return the delivery mechanism of this request, for example, for agent, web, scheduler, or sysAdmin.

This is the type of client application from which this user request is submitted, such as from Web, Agent, Scheduler or SysAdmin. We have the following types:

  • DssClientTypeReserved Not used.
  • DssClientTypeAgent 3-tier client except for scheduler.
  • DssClientTypeWeb 4-tier client.
  • DssClientTypeScheduler 3-tier scheduler.
  • DssClientTypeCustomApp Custom application.
  • DssClientTypeSysAdmin Not used.
    Parameters:
    pClientType Returns the type of the client application where this user request came from.
    Returns:
    Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::FinishTime (  [in] DATE  aDate  ) 
 

Returns the time when the DSS server finished executing this user request.

This property is updated upon re-execution of this user request.
Parameters:
aDate The time when the server finished processing this user request.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::FinishTime (  [out, retval] DATE *  pDate  ) 
 

Returns the time when the DSS server finished executing this user request.

This property is updated upon re-execution of this user request.
Parameters:
pDate Returns the time when the server finished processing this user request.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::FolderName (  [in] BSTR  FolderName  ) 
 

Set the name of the folder where the object resides.

Parameters:
FolderName The name of the folder where the object resides.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::FolderName (  [out, retval] BSTR *  pFolderName  ) 
 

This is the name of the folder where the object resides.

Parameters:
pFolderName Returns the name of the folder where the object resides.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgCreationTime (  [out, retval] DATE *  pDate  ) 
 

Returns the creation time of this inbox message.

Parameters:
pDate Returns the time when this inbox message was created.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgID (  [out, retval] BSTR *  pID  ) 
 

Returns the GUID of the inbox message.

Parameters:
pID Returns in a BSTR GUID that uniquely identifies this inbox message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.
  • E_FAIL Failed to turn DSSID into a BSTR

HRESULT IDSSServerMessage::MsgModificationTime (  [out, retval] DATE *  pDate  ) 
 

Returns the time when the inbox message is last modified.

Parameters:
pDate Returns the time when this inbox message was last modified.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgStatus (  [in] EnumDSSInBoxMessageStatus  Status  ) 
 

The status of the inbox message, for example, new or read.

Two useful statuses are DssInBoxNewMsg and DssInBoxReadMsg.

Enumeration Type Descriptions
  • DssInBoxStatusReserved Not used.
  • DssInBoxNewMsg New message, or unread message. If a read message is modified, its message status will be DssInBoxNewMsg again.
  • DssInBoxReadMsg Read message, indicating the user has already viewed this message.
  • DssInBoxDeletedMsg Not used.
Parameters:
Status The message status to be changed into.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgStatus (  [out, retval] EnumDSSInBoxMessageStatus *  pStatus  ) 
 

The status of the inbox message, for example, new or read.

Two useful statuses are DssInBoxNewMsg and DssInBoxReadMsg.

Enumeration Type Descriptions
  • DssInBoxStatusReserved Not used.
  • DssInBoxNewMsg New message, or unread message. If a read message is modified, its message status will be DssInBoxNewMsg again.
  • DssInBoxReadMsg Read message, indicating the user has already viewed this message.
  • DssInBoxDeletedMsg Not used.
Parameters:
pStatus Returns the type of this inbox message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgText (  [in] BSTR  MsgText  ) 
 

A text string of this inbox message.

It is the message body when the message is of type DssInBoxMsgTypeGeneral. It is also a text description of execution errors when the user requesting this message is about to run into an error in execution.. This is a text string of this inbox message. It may be an error description from the job execution, or some general statements created by the sysAdmin to inform all the users of the system status.

Parameters:
MsgText The message text to be written into this inbox message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgText (  [out, retval] BSTR *  pMsgText  ) 
 

A text string of this inbox message.

It is the message body when the message is of type DssInBoxMsgTypeGeneral. It is also a text description of execution errors when the user requesting this message is about to run into an error in execution.. This is a text string of this inbox message. It may be an error description from the job execution, or some general statements created by the sysAdmin to inform all the users of the system status.

Parameters:
pMsgText Returns the text string of this inbox message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgTitle (  [in] BSTR  MsgTitle  ) 
 

Set the title of the message.

If the message is about a report or document execution, the title is the name of the report or document. The title of this inbox message. If the message is about a report or document execution, this is the name of the report or document user submitted.

Parameters:
MsgTitle The title to be written into the inbox message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgTitle (  [out, retval] BSTR *  pMsgTitle  ) 
 

Returns the title of the message.

If the message is about a report or document execution, the title is the name of the report or document.. The title of this inbox message. If the message is about a report or document execution, this is the name of the report or document user submitted.

Parameters:
pMsgTitle Returns the title of the message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::MsgType (  [out, retval] EnumDSSInBoxMsgType *  pMsgType  ) 
 

Returns the type of the inbox message, for example, general message, persistent message or active job message.

  • DssInBoxMsgTypeReserved = 0 Not used.
  • DssInBoxMsgTypeGeneral = 1 The message is about the DSS system, thus not associated with any report or document execution.
  • DssInBoxMsgTypePersistent = 2 The message is about a report or document execution, and it is persisted in user's inbox file.
  • DssInBoxMsgTypeActive = 3 The message is about an active report or document execution, and it is not persisted in user's inbox file.
Parameters:
pMsgType Returns the type of this inbox message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ObjCreatorName (  [in] BSTR  CreatorName  ) 
 

This is the name of the creator of the object user submitted.

Parameters:
CreatorName The name of the creator of the object.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ObjCreatorName (  [out, retval] BSTR *  pCreatorName  ) 
 

Returns the name of the creator who created this object.

Parameters:
pCreatorName Returns the name of the creator of the object.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ObjDescription (  [in] BSTR  ObjDescription  ) 
 

This is a text description of the object user submitted.

Returns the description of the object submitted, for example, the description of a report or document.

Parameters:
ObjDescription A text description of the object to be written into the inbox message.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ObjDescription (  [out, retval] BSTR *  pObjDescription  ) 
 

Returns the description of the object submitted, for example, the description of a report or document.

This is a text description of the object user submitted.

Parameters:
pObjDescription Returns the text description of the object user submitted.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ObjectID (  [out, retval] BSTR *  pObjID  ) 
 

Returns the GUID of the object (that is, report or document) definition in the metadata.

This is the GUID of the object that the user requested. It could be a report definition ID, or a document definition ID.

Parameters:
pObjID Returns the definition ID of the object that the user asks for.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ParentMsgID (  [out, retval] BSTR *  pParentMsgID  ) 
 

The parent message ID of a child report message.

Returns the GUID of the parent message when this message is a child report message created in document execution.

It is only valid when the request type of the message is DssUserRequestChildReport. In other messages this property should always be GUID_NULL.
Parameters:
pParentMsgID Returns the message ID of the parent message of this child report request.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ProjectID (  [out, retval] BSTR *  pProjectID  ) 
 

Returns the GUID of the project that the object belongs to.

Parameters:
pProjectID Returns the ID of the project where the object resides.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ProjectName (  [in] BSTR  ProjectName  ) 
 

Returns the name of the project that the object belongs to.

Parameters:
ProjectName The name of the project where the object resides.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::ProjectName (  [out, retval] BSTR *  pProjectName  ) 
 

Returns the name of the project that the object belongs to.

Parameters:
pProjectName Returns the name of the project where the object resides.
Returns:
Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::RqstStatus (  [in] EnumDSSUserRequestStatus  aRqstStatus  ) 
 

Set the status of this user request, for example, report result ready, job execution or error.

  • DssUserRequestStatusReserved Not used.
  • DssResultReady User request is completed successfully. The result is ready for retrieving.
  • DssWaitForPrompt User request is a prompt report. It is waiting for client to give the prompt answer.
  • DssJobExecutionError User request is not successfully processed. See the message text for the detailed error description.
  • DssUserRequestQueued User request is being processed by the DSS server.
  • DssSqlGeneration User request is in SQL generation step.
  • DssSqlExecution User request is in SQL execution step.
  • DssInAnalyticalEngine User request is being cross-tabbed.
  • DssInResolutionServer User request is being resolved (meaning looking for prompts).
  • DssWaitingForCache User request is waiting for cache.
  • DssUpdatingCache User request is in update cache step.
  • DssWaiting User request is waiting in a queue for a processing unit.
  • DssWaitingOnGovernor User request is waiting for a governing setting to fall below the limit.
  • DssWaitForProject User request is waiting for project to be in execution state.
  • DssWaitingForChildren User request, that is, a document execution request, is waiting for its child reports to complete.
  • DssPackingSendingOutput Server is packing the result output of the user request.
  • DssRequestExecutionError This status is for server-side use only; in fact it is only for supporting 4-tier search feature. Both 3-tier and 4-tier GUI should never receive a message of this status.
    Parameters:
    aRqstStatus The request status to be set to.
    Returns:
    Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::RqstStatus (  [out, retval] EnumDSSUserRequestStatus *  pRqstStatus  ) 
 

Returns the status of this user request, for example, report result ready, job execution or error.

  • DssUserRequestStatusReserved Not used.
  • DssResultReady User request is completed successfully. The result is ready for retrieving.
  • DssWaitForPrompt User request is a prompt report. It is waiting for client to give the prompt answer.
  • DssJobExecutionError User request is not successfully processed. See the message text for the detailed error description.
  • DssUserRequestQueued User request is being processed by the DSS server.
  • DssSqlGeneration User request is in SQL generation step.
  • DssSqlExecution User request is in SQL execution step.
  • DssInAnalyticalEngine User request is being cross-tabbed.
  • DssInResolutionServer User request is being resolved (meaning looking for prompts).
  • DssWaitingForCache User request is waiting for cache.
  • DssUpdatingCache User request is in update cache step.
  • DssWaiting User request is waiting in a queue for a processing unit.
  • DssWaitingOnGovernor User request is waiting for a governing setting to fall below the limit.
  • DssWaitForProject User request is waiting for project to be in execution state.
  • DssWaitingForChildren User request, that is, a document execution request, is waiting for its child reports to complete.
  • DssPackingSendingOutput Server is packing the result output of the user request.
  • DssRequestExecutionError This status is for server-side use only; in fact it is only for supporting 4-tier search feature. Both 3-tier and 4-tier GUI should never receive a message of this status.
    Parameters:
    pRqstStatus Returns the status of user request.
    Returns:
    Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::RqstType (  [in] EnumDSSUserRequestType  RqstType  ) 
 

Get the type of the object the user has submitted, for example, a report, a document, or a workbook.

This is the type of user request.

  • DssUserRequestTypeReserved Not used.
  • DssUserRequestReport Report request.
  • DssUserRequestDynamicReport Not used. The original purpose of the enum is to distinguish those report requests that don't have a definition object in the metadata from those that have, which implies the ObjectID property of the message is useless.
  • DssUserRequestDocument Document request.
  • DssUserRequestWorkbook Not used.
  • DssUserRequestChildReport This is a message about a child report that is part of a document execution. Its ParentMsgID property is the GUID of its parent message (that is, a document message). For messages with other request types, the ParentMsgID property is not valid.
  • DssUserRequestSearching The message is about a 4-tier search request. It is for backend use only. Both 3-tier and 4-tier GUI should never receive a message of this request type.
    Parameters:
    RqstType The type of the user request.
    Returns:
    Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::RqstType (  [out, retval] EnumDSSUserRequestType *  pRqstType  ) 
 

Returns the type of the object the user has submitted, for example, a report, a document, or a workbook.

This is the type of user request.

  • DssUserRequestTypeReserved Not used.
  • DssUserRequestReport Report request.
  • DssUserRequestDynamicReport Not used. The original purpose of the enum is to distinguish those report requests that don't have a definition object in the metadata from those that have, which implies the ObjectID property of the message is useless.
  • DssUserRequestDocument Document request.
  • DssUserRequestWorkbook Not used.
  • DssUserRequestChildReport This is a message about a child report that is part of a document execution. Its ParentMsgID property is the GUID of its parent message (that is, a document message). For messages with other request types, the ParentMsgID property is not valid.
  • DssUserRequestSearching The message is about a 4-tier search request. It is for backend use only. Both 3-tier and 4-tier GUI should never receive a message of this request type.
    Parameters:
    pRqstType Returns the type of the user request.
    Returns:
    Usual COM result code:
  • S_OK Call succeeded.
  • E_POINTER User supplied a NULL output parameter.

HRESULT IDSSServerMessage::StartTime (  [in] DATE  aDate  ) 
 

Returns the time when the user request started to be processed by the DSS server.

HRESULT IDSSServerMessage::StartTime (  [out, retval] DATE *  pDate  ) 
 

Returns the time when the user request started to be processed by the DSS server.

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