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

IDSSJob2 Interface Reference

Inherits IDSSJob.

List of all members.


Detailed Description

The IDSSJob2 is added for NCS Job monitoring by Binh Nguyen on 2006-01-17.


Public Member Functions

HRESULT DeliveryType ([out, retval] EnumSubscriptionDeliveryType *opDeliveryType)
 This method returns the Delivery Type of the given NCS Job.
HRESULT Destination ([out, retval] BSTR *opDestination)
 This method returns the Destination (Email Address/File Location/Printer.
HRESULT IsExecutingInWarehouse ([out, retval] VARIANT_BOOL *opIsExecutingInWarehouse)
 This method returns whether the Job is Executing in Warehouse.
HRESULT IsSendNow ([out, retval] VARIANT_BOOL *opSendNow)
 This method returns whether the NCS Job is SendNow or not.
HRESULT ObjectGUID ([out, retval] BSTR *opObjectGUID)
 Get the ID of the object which this job executes.
HRESULT ProjectGUID ([out, retval] BSTR *opProjectGUID)
 Get the ID of the project in which this job executes.
HRESULT SubscriptionOwner ([out, retval] BSTR *opOwner)
 This method returns the Subscription Owner of the given NCS Job.
HRESULT SubscriptionRecipient ([out, retval] BSTR *opRecipient)
 This method returns the Subscription Recipient of the given NCS Job.


Member Function Documentation

HRESULT IDSSJob2::DeliveryType [out, retval] EnumSubscriptionDeliveryType opDeliveryType  ) 
 

This method returns the Delivery Type of the given NCS Job.

Parameters:
opDeliveryType The Delivery Type.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSJob2::Destination [out, retval] BSTR *  opDestination  ) 
 

This method returns the Destination (Email Address/File Location/Printer.

Display name + Physical Address. For contact group just say multiple.

Parameters:
opDestination The Destination of the subscription.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSJob2::IsExecutingInWarehouse [out, retval] VARIANT_BOOL *  opIsExecutingInWarehouse  ) 
 

This method returns whether the Job is Executing in Warehouse.

Parameters:
opIsExecutingInWarehouse can either be true or false
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSJob2::IsSendNow [out, retval] VARIANT_BOOL *  opSendNow  ) 
 

This method returns whether the NCS Job is SendNow or not.

Parameters:
opSendNow Send Now flag can either be true or false
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSJob2::ObjectGUID [out, retval] BSTR *  opObjectGUID  ) 
 

Get the ID of the object which this job executes.

Parameters:
opObjectGUID The ID of the object as a string.

HRESULT IDSSJob2::ProjectGUID [out, retval] BSTR *  opProjectGUID  ) 
 

Get the ID of the project in which this job executes.

This is the same string as the ID of the DSS Project object that defines this project.

Parameters:
opProjectGUID The ID of the project as a string.

HRESULT IDSSJob2::SubscriptionOwner [out, retval] BSTR *  opOwner  ) 
 

This method returns the Subscription Owner of the given NCS Job.

Parameters:
opOwner The Subscription Owner.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSJob2::SubscriptionRecipient [out, retval] BSTR *  opRecipient  ) 
 

This method returns the Subscription Recipient of the given NCS Job.

Parameters:
opRecipient The Subscription Recipient.
Returns:
Usual COM result code:
  • S_OK


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