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

IDSSSubscriptionInstance Interface Reference

List of all members.

Public Member Functions

HRESULT AddressID ([in] BSTR ipAddressID)
 Put the address ID.
HRESULT AddressID ([out, retval] BSTR *opAddressID)
 Get the address id.
HRESULT AddressName ([in] BSTR ipAddressName)
 Put the instance recipient address name.
HRESULT AddressName ([out, retval] BSTR *opAddressName)
 Get the instance recipient's address name.
HRESULT AllowChangeMask ([in] Int32 iChangeMask)
 Put the changeability mask.
HRESULT AllowChangeMask ([out, retval] Int32 *opChangeMask)
 Get the changeability mask.
HRESULT Contact ([in] IDSSSubscriptionContact *ipContact)
 Put the Contact object.
HRESULT Contact ([out, retval] IDSSSubscriptionContact oppContact)
 Get the contact object.
HRESULT ContactID ([in] BSTR ipContactID)
 Put the Contact ID.
HRESULT ContactID ([out, retval] BSTR *opContactID)
 Get the contact id.
HRESULT CreationTime ([in] DATE iCreationTimeLocal)
 Put the instance creation local time.
HRESULT CreationTime ([out, retval] DATE *opCreationTimeLocal)
 Get the instance creation local time.
HRESULT DataID ([in] BSTR ipDataID)
 Put the data id.
HRESULT DataID ([out, retval] BSTR *opContentID)
 Get the data id.
HRESULT DataType ([in] EnumDSSObjectType iDataType)
 Put the data type.
HRESULT DataType ([out, retval] EnumDSSObjectType *opDataType)
 Get the data type.
HRESULT DeliveryType ([in] EnumSubscriptionDeliveryType iDeliveryType)
 Put the delivery type.
HRESULT DeliveryType ([out, retval] EnumSubscriptionDeliveryType *opDeliveryType)
 Get the delivery type.
HRESULT ExtraXMLInfo ([out, retval] BSTR *opExtraXMLInfo)
 Get the instance extra XML info.
HRESULT get_Triggers ([out] Int32 *opNumTrigger,[out] BSTR *oppTriggerList)
 Get a list of triggers.
HRESULT Info ([out, retval] IDSSObjectInfo oppInfo)
HRESULT InitialID ([in] BSTR ipInitialID)
 Put the instance initial ID.
HRESULT InitialID ([out, retval] BSTR *opInitialID)
 Get the instance initial id.
HRESULT InstanceID ([in] BSTR ipInstanceID)
 Put the instance ID.
HRESULT InstanceID ([out, retval] BSTR *opInstanceID)
 Get the instance id.
HRESULT InstanceName ([in] BSTR ipInstanceName)
 Put the instance name.
HRESULT InstanceName ([out, retval] BSTR *opInstanceName)
 Get the instance name.
HRESULT MakeNewPersonalization ([in, optional] BSTR ID,[out, retval] IDSSSubscriptionPersonalization oppPersonalization)
 Make a new personalization.
HRESULT NotificationAddrID ([in] BSTR ipNotID)
 Put the notification address id.
HRESULT NotificationAddrID ([out, retval] BSTR *opNotID)
 Get the notification address id.
HRESULT OwnerID ([in] BSTR ipOwnerID)
 Put the owner ID.
HRESULT OwnerID ([out, retval] BSTR *opOwnerID)
 Get the owner id.
HRESULT OwnerName ([in] BSTR ipOwnerName)
 Put the instance's owner name.
HRESULT OwnerName ([out, retval] BSTR *opOwnerName)
 Get the instance's owner name.
HRESULT ParentInstanceID ([in] BSTR ipParentInstanceID)
 Put the parent instance id.
HRESULT ParentInstanceID ([out, retval] BSTR *opParentInstanceID)
 Get the parent instance id.
HRESULT pID ([in] BSTR ipPID)
 Put the personalization ID.
HRESULT pID ([out, retval] BSTR *opPID)
 Get the personalization id.
HRESULT ProjectID ([in] BSTR ipProjectID)
 Put the project ID.
HRESULT ProjectID ([out, retval] BSTR *opProjectID)
 Get the project id.
HRESULT put_Triggers ([in] Int32 iNumTriggers,[in, size_is(iNumTriggers)] BSTR *ipTriggerList)
 Put list of triggers.
HRESULT Status ([in] Int32 iStatus)
 Put the status.
HRESULT Status ([out, retval] Int32 *opStatus)
 Get the status.
HRESULT SubscriptionAddress ([in] IDSSSubscriptionAddress *ipAddress)
 Put the address object.
HRESULT SubscriptionAddress ([out, retval] IDSSSubscriptionAddress oppAddress)
 Get the address object.
HRESULT SubscriptionPersonalization ([in] IDSSSubscriptionPersonalization *ipPersonalization)
 Put the personalization object.
HRESULT SubscriptionPersonalization ([out, retval] IDSSSubscriptionPersonalization oppPersonalization)
 Get the personalization object.
HRESULT TriggerID ([in] BSTR ipTriggerID)
 Put the trigger id.
HRESULT TriggerID ([out, retval] BSTR *opTriggerID)
 Get the trigger id.

Member Function Documentation

HRESULT IDSSSubscriptionInstance::AddressID [in] BSTR  ipAddressID  ) 
 

Put the address ID.

Parameters:
ipAddressID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::AddressID [out, retval] BSTR *  opAddressID  ) 
 

Get the address id.

Parameters:
opAddressID Return the address guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::AddressName [in] BSTR  ipAddressName  ) 
 

Put the instance recipient address name.

Parameters:
ipAddressName the instance recipient address name.
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::AddressName [out, retval] BSTR *  opAddressName  ) 
 

Get the instance recipient's address name.

Parameters:
opAddressName Return the instance recipient address name.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::AllowChangeMask [in] Int32  iChangeMask  ) 
 

Put the changeability mask.

Parameters:
iChangeMask 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::AllowChangeMask [out, retval] Int32 *  opChangeMask  ) 
 

Get the changeability mask.

Parameters:
opChangeMask Return the changeability mask
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::Contact [in] IDSSSubscriptionContact ipContact  ) 
 

Put the Contact object.

Parameters:
ipContact 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::Contact [out, retval] IDSSSubscriptionContact   oppContact  ) 
 

Get the contact object.

Parameters:
oppContact Return the contact object.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::ContactID [in] BSTR  ipContactID  ) 
 

Put the Contact ID.

Parameters:
ipContactID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::ContactID [out, retval] BSTR *  opContactID  ) 
 

Get the contact id.

Parameters:
opContactID Return the contact guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::CreationTime [in] DATE  iCreationTimeLocal  ) 
 

Put the instance creation local time.

The time will be converted to GMT time base on the locale

Parameters:
iCreationTimeLocal 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::CreationTime [out, retval] DATE *  opCreationTimeLocal  ) 
 

Get the instance creation local time.

Parameters:
opCreationTimeLocal Return the instance creation time.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::DataID [in] BSTR  ipDataID  ) 
 

Put the data id.

Parameters:
ipDataID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::DataID [out, retval] BSTR *  opContentID  ) 
 

Get the data id.

Parameters:
opContentID Return the contact guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::DataType [in] EnumDSSObjectType  iDataType  ) 
 

Put the data type.

Parameters:
iDataType 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::DataType [out, retval] EnumDSSObjectType opDataType  ) 
 

Get the data type.

Parameters:
opDataType Return the contact guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::DeliveryType [in] EnumSubscriptionDeliveryType  iDeliveryType  ) 
 

Put the delivery type.

Parameters:
iDeliveryType 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

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

Get the delivery type.

Parameters:
opDeliveryType Return the contact guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::ExtraXMLInfo [out, retval] BSTR *  opExtraXMLInfo  ) 
 

Get the instance extra XML info.

This XML string will contain info about report name, prompt answers, etc.

Parameters:
opExtraXMLInfo Return the instance extra XML info.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::get_Triggers [out] Int32 *  opNumTrigger,
[out] BSTR *  oppTriggerList
 

Get a list of triggers.

Parameters:
opNumTrigger returns number of triggers.
oppTriggerList returns the list of trigger
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::Info [out, retval] IDSSObjectInfo   oppInfo  ) 
 

HRESULT IDSSSubscriptionInstance::InitialID [in] BSTR  ipInitialID  ) 
 

Put the instance initial ID.

Parameters:
ipInitialID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::InitialID [out, retval] BSTR *  opInitialID  ) 
 

Get the instance initial id.

Parameters:
opInitialID Return the instance initial guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::InstanceID [in] BSTR  ipInstanceID  ) 
 

Put the instance ID.

Parameters:
ipInstanceID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::InstanceID [out, retval] BSTR *  opInstanceID  ) 
 

Get the instance id.

Parameters:
opInstanceID Return the instance guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::InstanceName [in] BSTR  ipInstanceName  ) 
 

Put the instance name.

Parameters:
ipInstanceName 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::InstanceName [out, retval] BSTR *  opInstanceName  ) 
 

Get the instance name.

Parameters:
opInstanceName Return the instance name
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::MakeNewPersonalization [in, optional] BSTR  ID,
[out, retval] IDSSSubscriptionPersonalization   oppPersonalization
 

Make a new personalization.

Parameters:
ID The personalization ID
oppPersonalization 
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::NotificationAddrID [in] BSTR  ipNotID  ) 
 

Put the notification address id.

Parameters:
ipNotID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::NotificationAddrID [out, retval] BSTR *  opNotID  ) 
 

Get the notification address id.

Parameters:
opNotID Return the notification address id.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::OwnerID [in] BSTR  ipOwnerID  ) 
 

Put the owner ID.

Parameters:
ipOwnerID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::OwnerID [out, retval] BSTR *  opOwnerID  ) 
 

Get the owner id.

Parameters:
opOwnerID Return the owner id.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::OwnerName [in] BSTR  ipOwnerName  ) 
 

Put the instance's owner name.

Parameters:
ipOwnerName 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::OwnerName [out, retval] BSTR *  opOwnerName  ) 
 

Get the instance's owner name.

Parameters:
opOwnerName Return the instance owner name.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::ParentInstanceID [in] BSTR  ipParentInstanceID  ) 
 

Put the parent instance id.

Parameters:
ipParentInstanceID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::ParentInstanceID [out, retval] BSTR *  opParentInstanceID  ) 
 

Get the parent instance id.

Parameters:
opParentInstanceID Return the parent instance id.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::pID [in] BSTR  ipPID  ) 
 

Put the personalization ID.

Parameters:
ipPID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::pID [out, retval] BSTR *  opPID  ) 
 

Get the personalization id.

Parameters:
opPID Return the personalization guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::ProjectID [in] BSTR  ipProjectID  ) 
 

Put the project ID.

Parameters:
ipProjectID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::ProjectID [out, retval] BSTR *  opProjectID  ) 
 

Get the project id.

Parameters:
opProjectID Return the project guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::put_Triggers [in] Int32  iNumTriggers,
[in, size_is(iNumTriggers)] BSTR *  ipTriggerList
 

Put list of triggers.

Parameters:
iNumTriggers has number of triggers in list.
ipTriggerList contains the list of triggers
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::Status [in] Int32  iStatus  ) 
 

Put the status.

Parameters:
iStatus 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::Status [out, retval] Int32 *  opStatus  ) 
 

Get the status.

Parameters:
opStatus Return the contact guid.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::SubscriptionAddress [in] IDSSSubscriptionAddress ipAddress  ) 
 

Put the address object.

Parameters:
ipAddress 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::SubscriptionAddress [out, retval] IDSSSubscriptionAddress   oppAddress  ) 
 

Get the address object.

Parameters:
oppAddress Return the address object.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::SubscriptionPersonalization [in] IDSSSubscriptionPersonalization ipPersonalization  ) 
 

Put the personalization object.

Parameters:
ipPersonalization 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::SubscriptionPersonalization [out, retval] IDSSSubscriptionPersonalization   oppPersonalization  ) 
 

Get the personalization object.

Parameters:
oppPersonalization Return the personalization object
Returns:
Usual COM result code:
  • S_OK Operation succeeded.

HRESULT IDSSSubscriptionInstance::TriggerID [in] BSTR  ipTriggerID  ) 
 

Put the trigger id.

Parameters:
ipTriggerID 
Returns:
Usual COM result code:
  • S_OK Operation was successful.

HRESULT IDSSSubscriptionInstance::TriggerID [out, retval] BSTR *  opTriggerID  ) 
 

Get the trigger id.

Parameters:
opTriggerID Return the trigger id.
Returns:
Usual COM result code:
  • S_OK Operation succeeded.


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