IDSSDataSource Interface Reference

Inherited by IDSSDataSource2.

List of all members.

---

Detailed Description

The IDSSDataSource interface is used to support the client to connect to a server or to create a session to connect to a project.

The DSSDataSource object is created for the client by the DSSSourceEnumerator object. The client does not call a CoCreateInstance(though it can).

The Mode property and Type property determine the main behavior of a data source. The Mode property determines the connection mode of the data source. The Type property determines to which type of depository the data source points.

A DSSDataSource can contain a collection of DSSDataSource objects through a DSSSourceEnumerator object. In this case, the client can get the IDSSSourceEnumerator interface of the enumerator object and create a DSSSession object.

Through a project DSSDataSource object, the client can get the project name, the project ID, and create a DSSSession object for this project. A project DSSDataSource object does not contain a collection of DSSDataSource objects.

Before creating a session, the data source should be initialized through Init() method.

After initialization, the properties of the data source cannot be changed. The client has to reset the data source first, then change the properties.

It is required to reset the data source before releasing it if it was initialized.

Public Member Functions
HRESULT	Administrator ([out, retval] BSTR *pAdministrator)
	The login of the Administrator user account.
HRESULT	ApplicationType ([in] EnumDSSApplicationType AppType)
	The application type of this data source.
HRESULT	ApplicationType ([out, retval] EnumDSSApplicationType *pAppType)
	The application type of this data source.
HRESULT	AuthMode ([in] EnumDSSAuthModes AuthMode)
	Put the authentication mode for this data source.
HRESULT	AuthMode ([out, retval] EnumDSSAuthModes *pAuthMode)
	Get the authentication mode for this data source.
HRESULT	AuthModesAvailable ([out, retval] Int32 *pAuthModesAvailable)
	The available authentication modes for this data source.
HRESULT	CacheSetting ([in] EnumDSSCacheSetting CacheSettingType,[in] VARIANT *pCacheSetting)
	Set properties that modify the behavior of caches associated with this datasource.
HRESULT	CacheSetting ([in] EnumDSSCacheSetting CacheSettingType,[out, retval] VARIANT *pCacheSetting)
	Get properties that modify the behavior of caches associated with this datasource.
HRESULT	ConfigurationID ([in] BSTR ConfigurationID)
	The GUID of the Configuration object.
HRESULT	ConfigurationID ([out, retval] BSTR *pConfigurationID)
	The GUID of the Configuration object.
HRESULT	ConfigurationName ([in] BSTR ConfigurationName)
	The name of the Configuration object.
HRESULT	ConfigurationName ([out, retval] BSTR *pConfigurationName)
	The name of the Configuration object.
HRESULT	Create ([out, retval] IDSSCreate ppCreate)
	The interface of IDSSCreate.
HRESULT	CreateSession ([out, retval] IDSSSession ppSession)
	Create a session for the project this data source represents.
HRESULT	DBType ([in] EnumDSSDatabaseType DBType)
	Get the type of database used to support the metadata repository.
HRESULT	DBType ([out, retval] EnumDSSDatabaseType *pDBType)
	Set the type of database used to support the metadata repository.
HRESULT	Delete ([out, retval] IDSSDelete ppDelete)
	Get interface to component used to destroy projects.
HRESULT	DeleteFromRegistry ()
	This method deletes the information of the data source from the registry.
HRESULT	Duplicate ([in] BSTR DataSourceName,[out, retval] IDSSDataSource ppDataSource)
	Duplicate this data source.
HRESULT	Enumerator ([in, defaultvalue(DssDataSourceRefreshOptionNotRefresh)] EnumDSSDataSourceRefreshOption Flag,[out, retval] IDSSDataSourceEnumerator ppDataSourceEnumerator)
	Get an enumerator over datasources accessible from this data source.
HRESULT	Flags ([in] EnumDSSDataSourceFlags Flags)
	The flags of this data source.
HRESULT	Flags ([out, retval] EnumDSSDataSourceFlags *pFlags)
	The flags of this data source.
HRESULT	Hidden ([in] VARIANT_BOOL Hidden)
	Indicate whether to show this data source in MicroStrategy Desktop or not.
HRESULT	Hidden ([out, retval] VARIANT_BOOL *pHidden)
	Indicate whether to show this data source in MicroStrategy Desktop or not.
HRESULT	Init ()
	This method initializes the data source, and prepares to create session.
HRESULT	InternalProjectID ([in] Int32 InternalProjectID)
	Set the Intelligence Server's internal identifier for a 3-tier project.
HRESULT	InternalProjectID ([out, retval] Int32 *pInternalProjectID)
	Get the Intelligence Server's internal identifier for a 3-tier project.
HRESULT	IsInitialized ([out, retval] VARIANT_BOOL *pIsInitialized)
	Check whether the data source is initialized.
HRESULT	Locale ([in] Int32 Locale)
	The localization of this data source.
HRESULT	Locale ([out, retval] Int32 *pLocale)
	The localization of this data source.
HRESULT	Location ([in] BSTR Location)
	The depository to which the data source points.
HRESULT	Location ([out, retval] BSTR *pLocation)
	The depository to which the data source points.
HRESULT	login ([in] BSTR Login)
HRESULT	login ([out, retval] BSTR *pLogin)
HRESULT	MDLogin ([in] BSTR Login)
	The metadata login for pass through authentication against the metadata server.
HRESULT	MDLogin ([out, retval] BSTR *pLogin)
	The metadata login for pass through authentication against the metadata server.
HRESULT	MDPasswd ([in] BSTR Passwd)
	The metadata password for pass through authentication against the metadata server.
HRESULT	MDPasswd ([out, retval] BSTR *pPasswd)
	The metadata password for pass through authentication against the metadata server.
HRESULT	MDVersion ([in] EnumDSSMDVersion MDVersion)
	Set the version of the metadata.
HRESULT	MDVersion ([out, retval] EnumDSSMDVersion *pMDVersion)
	Get the version of the metadata.
HRESULT	Mode ([in] EnumDSSConnectionMode Mode)
	The tier mode corresponding to this data source.
HRESULT	Mode ([out, retval] EnumDSSConnectionMode *pMode)
	The tier mode corresponding to this data source.
HRESULT	Name ([in] BSTR DataSourceName)
	The name of the data source.
HRESULT	Name ([out, retval] BSTR *pDataSourceName)
	The name of the data source.
HRESULT	NewPasswd ([in] BSTR NewPasswd)
	Set a changed password to set during the next standard authentication.
HRESULT	NewPasswd ([out, retval] BSTR *pNewPasswd)
	Get a changed password to set during the next standard authentication.
HRESULT	passwd ([in] BSTR Passwd)
HRESULT	passwd ([out, retval] BSTR *pPasswd)
HRESULT	port ([in] Int32 Port)
HRESULT	port ([out, retval] Int32 *pPort)
HRESULT	ProjectDescription ([out, retval] BSTR *pProjectDescription)
	The description of the project.
HRESULT	ProjectID ([in] BSTR ProjectID)
	Set the ProjectID GUID of the project this data source represents.
HRESULT	ProjectID ([out, retval] BSTR *pProjectID)
	Get the ProjectID GUID of the project this data source represents.
HRESULT	ProjectName ([in] BSTR ProjectName)
	The name of the project this data source represents.
HRESULT	ProjectName ([out, retval] BSTR *pProjectName)
	The name of the project this data source represents.
HRESULT	Reset ()
	Reset the data source.
HRESULT	SaveToRegistry ([in, optional] VARIANT_BOOL OverWritten)
	Write the properties of this data source into the registry.
HRESULT	ServerAdmin ([out, retval] IDSSServerAdmin ppServerAdmin)
	The ServerAdmin of this data source for a 3-tier or 4-tier connection.
HRESULT	ServerInstanceID ([in] BSTR ServerInstanceID)
	The ID of the DSS Server Definition object.
HRESULT	ServerInstanceID ([out, retval] BSTR *pServerInstanceID)
	The ID of the DSS Server Definition object.
HRESULT	ServerInstanceName ([in] BSTR ServerInstanceName)
	The name of the ServerDef object.
HRESULT	ServerInstanceName ([out, retval] BSTR *pServerInstanceName)
	The name of the ServerDef object.
HRESULT	SessionFlags ([in] EnumDSSSessionFlags Flags)
	Set the session flags for this data source.
HRESULT	SessionFlags ([out, retval] EnumDSSSessionFlags *pFlags)
	Get the session flags for this data source.
HRESULT	Timeout ([in] Int32 Timeout)
	The client-server connection time out.
HRESULT	Timeout ([out, retval] Int32 *pTimeout)
	The client-server connection time out.
HRESULT	Type ([in] EnumDSSDataSourceType Type)
	Set the type of this data source.
HRESULT	Type ([out, retval] EnumDSSDataSourceType *pType)
	Get the type of this data source.
HRESULT	WebServerAdmin ([out, retval] IDSSWebServerAdmin ppWebServerAdmin)
	The WebServerAdmin of this data source (only for 4-tier mode).
HRESULT	WHLogin ([in] BSTR Login)
	The login of warehouse database for pass through authentication.
HRESULT	WHLogin ([out, retval] BSTR *pLogin)
	The login of warehouse database for pass through authentication.
HRESULT	WHPasswd ([in] BSTR Passwd)
	The password of warehouse database for pass through authentication.
HRESULT	WHPasswd ([out, retval] BSTR *pPasswd)
	The password of warehouse database for pass through authentication.

---

Member Function Documentation

HRESULT IDSSDataSource::Administrator (  [out, retval] BSTR *  pAdministrator  )

The login of the Administrator user account. Parameters: pAdministrator  A pointer to the string that contains the login of the Administrator user account. Returns: Usual COM result code: S_OK E_POINTER Memory for pAdministrator was not allocated before calling this method.

HRESULT IDSSDataSource::ApplicationType (  [in] EnumDSSApplicationType  AppType  )

The application type of this data source. The application type of a datasource indicates the application that created the data source. Parameters: AppType  The application type of this data source. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for pApplicationType was not allocated before calling this method.

HRESULT IDSSDataSource::ApplicationType (  [out, retval] EnumDSSApplicationType *  pAppType  )

The application type of this data source. The application type of a datasource indicates the application that created the data source. Parameters: pAppType  A pointer to the application type. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for pApplicationType was not allocated before calling this method.

HRESULT IDSSDataSource::AuthMode (  [in] EnumDSSAuthModes  AuthMode  )

Put the authentication mode for this data source. The available enumerated values are: DssAuthStandard Standard authentication DssAuthNTCredential NT credential authentication DssAuthPassThrough RDBMS authentication DssAuthAnonymous Anonymous authentication DssAuthLDAP LDAP authentication DssAuthWarehousePassthrough Warehouse passthrough authentication If MDVersion is DssMDVersion4, only DssAuthPassThrough authentication mode is supported. If MDVersion is DssMDVersion7, all authentication modes are supported (except that DssAuthLDAP is not supported in DssConnectionModeDirectAccess mode. Parameters: AuthMode  Authentication Mode. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for pAuthMode was not allocated before calling this method.

HRESULT IDSSDataSource::AuthMode (  [out, retval] EnumDSSAuthModes *  pAuthMode  )

Get the authentication mode for this data source. The available enumerated values are: DssAuthStandard Standard authentication DssAuthNTCredential NT credential authentication DssAuthPassThrough RDBMS authentication DssAuthAnonymous Anonymous authentication DssAuthLDAP LDAP authentication DssAuthWarehousePassthrough Warehouse passthrough authentication If MDVersion is DssMDVersion4, only DssAuthPassThrough authentication mode is supported. If MDVersion is DssMDVersion7, all authentication modes are supported (except that DssAuthLDAP is not supported in DssConnectionModeDirectAccess mode. Parameters: pAuthMode  A pointer to the Authentication Mode. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for pAuthMode was not allocated before calling this method.

HRESULT IDSSDataSource::AuthModesAvailable (  [out, retval] Int32 *  pAuthModesAvailable  )

The available authentication modes for this data source. This is a bit-wise long value that contains all available authentication modes supported by this data source. The enumerated authentication mode values are described in property AuthMode. The data source uses the Type property to determine its available authentication modes. So, Type property should be set before using this property. Parameters: pAuthModesAvailable  A pointer to the long value. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for pAuthModesAvailable was not allocated before calling this method.

HRESULT IDSSDataSource::CacheSetting (  [in] EnumDSSCacheSetting  CacheSettingType, [in] VARIANT *  pCacheSetting )

Set properties that modify the behavior of caches associated with this datasource. The EnumDSSCacheSetting enumeration lists the various properties that can be assigned for a datasource. DssCacheSettingObjectFileCachePath, DssCacheSettingElementFileCachePath, and DssCacheSettingReportFileCachePath are string-value cache settings. DssCacheSettingObjectSwapPolicy , DssCacheSettingElementSwapPolicy, and DssCacheSettingReportSwapPolicy are 0-1-value cache settings, where 0 means LRU (least recent used) swap policy and 1 means LHC (least hit count) swap policy. All others are 4-byte integer valued cache settings. Parameters: CacheSettingType  Indicates which cache setting is to be set. pCacheSetting  The new cache setting value. Returns: Usual COM result code: S_OK E_INVALIDARG PCacheSettingNewValue is not a valid cache setting value or CacheSettingType is not a valid cache type. E_POINTER Memory for pCacheSetting was not allocated before calling this method.

HRESULT IDSSDataSource::CacheSetting (  [in] EnumDSSCacheSetting  CacheSettingType, [out, retval] VARIANT *  pCacheSetting )

Get properties that modify the behavior of caches associated with this datasource. The EnumDSSCacheSetting enumeration lists the various properties that can be assigned for a datasource. DssCacheSettingObjectFileCachePath, DssCacheSettingElementFileCachePath, and DssCacheSettingReportFileCachePath are string-value cache settings. DssCacheSettingObjectSwapPolicy , DssCacheSettingElementSwapPolicy, and DssCacheSettingReportSwapPolicy are 0-1-value cache settings, where 0 means LRU (least recent used) swap policy and 1 means LHC (least hit count) swap policy. All others are 4-byte integer valued cache settings. Parameters: CacheSettingType  Indicates which cache setting is to be set or get. pCacheSetting  A pointer to a Variant that contains the cache setting value. Returns: Usual COM result code: S_OK E_INVALIDARG PCacheSettingNewValue is not a valid cache setting value or CacheSettingType is not a valid cache type. E_POINTER Memory for pCacheSetting was not allocated before calling this method.

HRESULT IDSSDataSource::ConfigurationID (  [in] BSTR  ConfigurationID  )

The GUID of the Configuration object. The GUID of the Configuration object that contains information about a configuration. This one is optional. If this is not set, during data source initialization, this one is set as following: If Mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeConfiguration, data source will get it based on ConfigurationName. If Mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeServer, data source will get it from ServerDef. If Mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeProjectMD7, data source will get it from Project. If Mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess, data source will get it from Server. Actually this property is superfluous since each repository only has one configuration object, and the ID of that configuration object is always the same. Parameters: ConfigurationID  The GUID of the Configuration object. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the GUID of Configuration object if the data source is initialized. E_POINTER Memory for pConfigurationID was not allocated before calling this method.

HRESULT IDSSDataSource::ConfigurationID (  [out, retval] BSTR *  pConfigurationID  )

The GUID of the Configuration object. The GUID of the Configuration object that contains information about a configuration. This one is optional. If this is not set, during data source initialization, this one is set as following: If Mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeConfiguration, data source will get it based on ConfigurationName. If Mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeServer, data source will get it from ServerDef. If Mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeProjectMD7, data source will get it from Project. If Mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess, data source will get it from Server. Actually this property is superfluous since each repository only has one configuration object, and the ID of that configuration object is always the same. Parameters: pConfigurationID  A pointer to a BSTR that contains the GUID of the Configuration object. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the GUID of Configuration object if the data source is initialized. E_POINTER Memory for pConfigurationID was not allocated before calling this method.

HRESULT IDSSDataSource::ConfigurationName (  [in] BSTR  ConfigurationName  )

The name of the Configuration object. The name of the Configuration object that contains information about a configuration. This one is optional. The default is "CASTOR_SERVER_CONFIGURATION". Parameters: ConfigurationName  The name of the Configuration object. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the name of Configuration object if the data source is initialized. E_POINTER Memory for pConfigurationName was not allocated before calling this method.

HRESULT IDSSDataSource::ConfigurationName (  [out, retval] BSTR *  pConfigurationName  )

The name of the Configuration object. The name of the Configuration object that contains information about a configuration. This one is optional. The default is "CASTOR_SERVER_CONFIGURATION". Parameters: pConfigurationName  A pointer to a BSTR that contains the name of the Configuration object. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the name of Configuration object if the data source is initialized. E_POINTER Memory for pConfigurationName was not allocated before calling this method.

HRESULT IDSSDataSource::Create (  [out, retval] IDSSCreate   ppCreate  )

The interface of IDSSCreate. Parameters: ppCreate  A pointer to the IDSSCreate interface. Returns: Usual COM result code: S_OK E_POINTER Memory for ppCreate was not allocated before calling this method.

HRESULT IDSSDataSource::CreateSession (  [out, retval] IDSSSession   ppSession  )

Create a session for the project this data source represents. This method creates a DSSSession object form which the client can get the components to perform different tasks. The DSSSession object should be closed before it is released. Parameters: ppSession  A pointer to the IDSSSession interface of the created DSSSession object. Returns: Usual COM result code: S_OK DSSCOM_E_NOTINITIALIZED Cannot create a session since the data source is not initialized. CLNTCONN_E_DATASOURCE_SERVER_NOT_CONNECTED Cannot create a session since the connection to the server is not succeeded in 3-tier or 4-tier mode. E_OUTOFMEMORY Memory space is depleted.

HRESULT IDSSDataSource::DBType (  [in] EnumDSSDatabaseType  DBType  )

Get the type of database used to support the metadata repository. This information needs to be recorded in the datasource, since we need to know the platform used to support the metadata before we can read any configuration information from the metadata. Parameters: DBType  The data base type. Returns: Usual COM result code: S_OK E_POINTER Memory for pDBType was not allocated before calling this method.

HRESULT IDSSDataSource::DBType (  [out, retval] EnumDSSDatabaseType *  pDBType  )

Set the type of database used to support the metadata repository. This information needs to be recorded in the datasource, since we need to know the platform used to support the metadata before we can read any configuration information from the metadata. Parameters: pDBType  A pointer to the data base type. Returns: Usual COM result code: S_OK E_POINTER Memory for pDBType was not allocated before calling this method.

HRESULT IDSSDataSource::Delete (  [out, retval] IDSSDelete   ppDelete  )

Get interface to component used to destroy projects. Parameters: ppDelete  A pointer to the IDSSDelete interface. Returns: Usual COM result code: S_OK E_POINTER Memory for ppDelete was not allocated before calling this method.

HRESULT IDSSDataSource::DeleteFromRegistry (   )

This method deletes the information of the data source from the registry. Returns: Usual COM result code: S_OK CLNTCONN_E_REGISTRY_DELETE_FAIL Failure to delete the registry key corresponding to this data source. E_OUTOFMEMORY Memory space is depleted.

HRESULT IDSSDataSource::Duplicate (  [in] BSTR  DataSourceName, [out, retval] IDSSDataSource   ppDataSource )

Duplicate this data source. This method creates a new data source with the same property values as this data source, except the data source name. Parameters: DataSourceName  The name of the new data source. ppDataSource  A pointer to IDSSDataSource interface of the new data source. Returns: Usual COM result code: S_OK E_POINTER Memory for ppDataSource was not allocated before calling this method.

HRESULT IDSSDataSource::Enumerator (  [in, defaultvalue(DssDataSourceRefreshOptionNotRefresh)] EnumDSSDataSourceRefreshOption  Flag, [out, retval] IDSSDataSourceEnumerator   ppDataSourceEnumerator )

Get an enumerator over datasources accessible from this data source. The enumerator in this data source, which contains a collection of DSSDataSource objects corresponding to the projects. The data source should be initialized before getting this property. If Type is DssDataSourceTypeProjectMD7, the enumerator is an empty collection. If Type is DssDataSourceTypeProjectMD4, the enumerator will contain one data source that is the same as this one. If Mode is DssConnectionModeDirectAccess and Type is DssTypeDSConfiguration (metadata version is DssMDVersionMD7), data source gets project objects from the Configuration depository and creates new project data sources. If Mode is DssConnectionModeDirectAccess and Type is DssTypeDSServer (metadata version is DssMDVersionMD7), data source gets project references from the ServerDef object and creates new project data sources. If Mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess and Type is DssTypeDSConfiguration, data source gets project objects from the Configuration depository in the Server and creates new project data sources. If Mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess and Type is DssTypeDSServer, data source gets project instances from the Server and creates new project data sources. Flag controls whether to refresh the enumerator or not. If Flag is DssDataSourceRefreshOptionRefresh, data source clears the enumerator and creates new project data source under the enumerator. However, a new project data source is not created if there is an existed one that corresponds to the same project and is initialized. The data source ignores Flag when its enumerator is NULL. Parameters: Flag  The value of EnumDSSDataSourceRefreshOption which determine whether to get project instances from Server in 3 tier or 4 tier mode, or whether to get project references from the ServerDef object in 2 tier mode. The available values of EnumDSSDataSourceRefreshOption are: ppDataSourceEnumerator  A pointer to the IDSSDataSourceEnumerator interface. Returns: Usual COM result code: S_OK CLNTCONN_E_TIER_MODE_NOT_SET The mode of the data source is not set. E_OUTOFMEMORY Fail to create the new enumerator or the new project data sources. E_POINTER Memory for ppEnumerator was not allocated before calling this method.

HRESULT IDSSDataSource::Flags (  [in] EnumDSSDataSourceFlags  Flags  )

The flags of this data source. This is a bit-wise enumeration type EnumDSSDataSourceFlags. The properties record information about the entire datasource and its warehouse. Parameters: Flags  The flags of this data source. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the flags if the data source is initialized. E_POINTER Memory for pFlags was not allocated before calling this method.

HRESULT IDSSDataSource::Flags (  [out, retval] EnumDSSDataSourceFlags *  pFlags  )

The flags of this data source. This is a bit-wise enumeration type EnumDSSDataSourceFlags. The properties record information about the entire datasource and its warehouse. Parameters: pFlags  A pointer to the flags. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the flags if the data source is initialized. E_POINTER Memory for pFlags was not allocated before calling this method.

HRESULT IDSSDataSource::Hidden (  [in] VARIANT_BOOL  Hidden  )

Indicate whether to show this data source in MicroStrategy Desktop or not. This property is used to hide certain datasources from casual viewing. An interested user can still ask to see hidden datasources - this feature is intended to be used for convenience not security. Parameters: Hidden  Indicate whether to show this data source in DSSOffice or not. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for pHidden was not allocated before calling this method.

HRESULT IDSSDataSource::Hidden (  [out, retval] VARIANT_BOOL *  pHidden  )

Indicate whether to show this data source in MicroStrategy Desktop or not. This property is used to hide certain datasources from casual viewing. An interested user can still ask to see hidden datasources - this feature is intended to be used for convenience not security. Parameters: pHidden  A pointer to the BOOL value. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for pHidden was not allocated before calling this method.

HRESULT IDSSDataSource::Init (   )

This method initializes the data source, and prepares to create session. After Init method is called, the client cannot set the properties of the data source. The client can call Reset method to reset the data source and then can set the properties of the data source. If Mode is DssConnectionModeDirectAccess, it creates a metadata, tests the metadata connection, and authenticates. If Type is DssDataSourceTypeConfiguration, it sets ConfigurationID based on ConfigurationName if the one is not set. If Type is DssDataSourceTypeServer, it sets ServerInstanceID based on ServerInstanceName if the one is not set and get the ConfigurationID from ServerDef object. If Type is DssDataSourceTypeProjectMD7, it sets ProjectID based on ProjectName if the one is not set, gets the ConfigurationID from Project object, and logs in to the project. If Type is DssDataSourceTypeProjectMD4, it logs in to the project. If Mode is DssConnectionModeServerAccess, it creates and initializes a NetSockect, connect to the Server, authenticates, and creates a server admin. It gets the ConfigurationID from the Server. If Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7, it logs in to the project. If Mode is DssConnectionModeWebAccess, it creates and initializes a NetHttp, connects to the Server, authenticates, and creates a server admin and a web server admin. It gets the ConfigurationID from the Server. If Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7, it logs in to the project. This method will redo authentication and failure portion of the initialization if it is called again. Reset method should be called before the data source is released if initialization succeeds Returns: Usual COM result code: S_OK DSSCOM_E_NULLSTRING One string value property is empty value or null value. CLNTCONN_E_INVALID_MDVERSION Wrong metadata version. CLNTCONN_E_TIER_MODE_NOT_SET The connection mode is not set.

HRESULT IDSSDataSource::InternalProjectID (  [in] Int32  InternalProjectID  )

Set the Intelligence Server's internal identifier for a 3-tier project. The Intelligence Server assigns an integer value to each project. This number is not recorded in the repository (unlike the ProjectID) and so cannot be assumed to be the same each time a connection is established to the project. Some of the server administration methods need to know the internal project ID of the project to which they are applied. This property is only valid if the mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess. Parameters: InternalProjectID  The internal project ID of this data source. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the internal project ID if the data source is initialized. CLNTCONN_E_PROPERTY_PUT_34TIER The property is not available in a 2-tier data source. E_POINTER Memory for pInternalProjectID was not allocated before calling this method.

HRESULT IDSSDataSource::InternalProjectID (  [out, retval] Int32 *  pInternalProjectID  )

Get the Intelligence Server's internal identifier for a 3-tier project. The Intelligence Server assigns an integer value to each project. This number is not recorded in the repository (unlike the ProjectID) and so cannot be assumed to be the same each time a connection is established to the project. Some of the server administration methods need to know the internal project ID of the project to which they are applied. This property is only valid if the mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess. Parameters: pInternalProjectID  A pointer to the internel project ID. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the internal project ID if the data source is initialized. CLNTCONN_E_PROPERTY_PUT_34TIER The property is not available in a 2-tier data source. E_POINTER Memory for pInternalProjectID was not allocated before calling this method.

HRESULT IDSSDataSource::IsInitialized (  [out, retval] VARIANT_BOOL *  pIsInitialized  )

Check whether the data source is initialized. Return true if the data source is initialized; otherwise, return False. Parameters: pIsInitialized  A pointer to a VARIANT_BOOL that identifies whether the data source is initialized. Returns: Usual COM result code: S_OK E_POINTER Memory for pIsInitialized was not allocated before calling this method.

HRESULT IDSSDataSource::Locale (  [in] Int32  Locale  )

The localization of this data source. It is used to indicate which localization is used in report results and messages. The default value is LOCALE_USER_DEFAULT. Parameters: Locale  The locale of this data source. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the locale if the data source is initialized. E_POINTER Memory for pLocale was not allocated before calling this method.

HRESULT IDSSDataSource::Locale (  [out, retval] Int32 *  pLocale  )

The localization of this data source. It is used to indicate which localization is used in report results and messages. The default value is LOCALE_USER_DEFAULT. Parameters: pLocale  A pointer to the locale. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the locale if the data source is initialized. E_POINTER Memory for pLocale was not allocated before calling this method.

HRESULT IDSSDataSource::Location (  [in] BSTR  Location  )

The depository to which the data source points. This property indicates to which the data source points. If Mode is DssConnectionModeDirectAccess and MDVersion is DssMDVersionMD7, this is the metadata connection string. If Mode is DssConnectionModeDirectAccess and MDVersion is DssMDVersionMD4, this is either the metadata connection string or the DSS file name (full path). If Mode is DssConnectionModeServerAccess, this is the server machine name. If Mode is DssConnectionModeWebAccess, this is the WEB server URL. Parameters: Location  The BSTR indicates to which the data source points. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the metadata ODBC string if the data source is initialized. CLNTCONN_E_PROPERTY_GET_2TIER MDODBCString is a valid property only if the mode is 2-tier. CLNTCONN_E_PROPERTY_PUT_2TIER MDODBCString is a valid property only if the mode is 2-tier. E_POINTER Memory for pMDODBCString was not allocated before calling this method.

HRESULT IDSSDataSource::Location (  [out, retval] BSTR *  pLocation  )

The depository to which the data source points. This property indicates to which the data source points. If Mode is DssConnectionModeDirectAccess and MDVersion is DssMDVersionMD7, this is the metadata connection string. If Mode is DssConnectionModeDirectAccess and MDVersion is DssMDVersionMD4, this is either the metadata connection string or the DSS file name (full path). If Mode is DssConnectionModeServerAccess, this is the server machine name. If Mode is DssConnectionModeWebAccess, this is the WEB server URL. Parameters: pLocation  A pointer to a BSTR that indicates to which the data source points. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the metadata ODBC string if the data source is initialized. CLNTCONN_E_PROPERTY_GET_2TIER MDODBCString is a valid property only if the mode is 2-tier. CLNTCONN_E_PROPERTY_PUT_2TIER MDODBCString is a valid property only if the mode is 2-tier. E_POINTER Memory for pMDODBCString was not allocated before calling this method.

HRESULT IDSSDataSource::login (  [in] BSTR  Login  )

HRESULT IDSSDataSource::login (  [out, retval] BSTR *  pLogin  )

HRESULT IDSSDataSource::MDLogin (  [in] BSTR  Login  )

The metadata login for pass through authentication against the metadata server. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one will overwrite the one in the DSS file and the one in the metadata connection string (Location property). Parameters: Login  The login of the metadata database or pass through authentication. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the MDLogin if the data source is initialized. E_POINTER Memory for pMDLoginID was not allocated before calling this method.

HRESULT IDSSDataSource::MDLogin (  [out, retval] BSTR *  pLogin  )

The metadata login for pass through authentication against the metadata server. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one will overwrite the one in the DSS file and the one in the metadata connection string (Location property). Parameters: pLogin  A pointer to a BSTR of the login. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the MDLogin if the data source is initialized. E_POINTER Memory for pMDLoginID was not allocated before calling this method.

HRESULT IDSSDataSource::MDPasswd (  [in] BSTR  Passwd  )

The metadata password for pass through authentication against the metadata server. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one will overwrite the one in the DSS file and the one in the metadata connection string (Location property). Parameters: Passwd  The password of the metadata database or the password of pass through authentication. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the MDPassword if the data source is initialized. E_POINTER Memory for pMDPassword was not allocated before calling this method.

HRESULT IDSSDataSource::MDPasswd (  [out, retval] BSTR *  pPasswd  )

The metadata password for pass through authentication against the metadata server. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one will overwrite the one in the DSS file and the one in the metadata connection string (Location property). Parameters: pPasswd  A pointer to a BSTR of the password. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the MDPassword if the data source is initialized. E_POINTER Memory for pMDPassword was not allocated before calling this method.

HRESULT IDSSDataSource::MDVersion (  [in] EnumDSSMDVersion  MDVersion  )

Set the version of the metadata. It is an enumeration EnumDSSMDVersion. The current available enumerated values of EnumDSSMDVersion are: DssMDVersionMD4 Version 6 (Abell) metadata DssMDVersionMD7 Version 7 metadata Parameters: MDVersion  The version of the metadata Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the metadata version if the data source is initialized. E_POINTER Memory for pMDVersion was not allocated before calling this method.

HRESULT IDSSDataSource::MDVersion (  [out, retval] EnumDSSMDVersion *  pMDVersion  )

Get the version of the metadata. It is an enumeration EnumDSSMDVersion. The current available enumerated values of EnumDSSMDVersion are: DssMDVersionMD4 Version 6 (Abell) metadata DssMDVersionMD7 Version 7 metadata Parameters: pMDVersion  The pointer to MDVersion Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the metadata version if the data source is initialized. E_POINTER Memory for pMDVersion was not allocated before calling this method.

HRESULT IDSSDataSource::Mode (  [in] EnumDSSConnectionMode  Mode  )

The tier mode corresponding to this data source. It is an enumeration, EnumDSSConnectionMode. The available values of EnumDSSConnectionMode are: DssConnectionModeDirectAccess 2-tier connection mode DssConnectionModeServerAccess 3-tier connection mode DssConnectionModeWebAccess 4-tier connection mode (Note: It is not supported now and is reserved for future expansion) Parameters: Mode  The tier mode or the client connection mode. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the connection mode if the data source is initialized. E_POINTER Memory for pMode was not allocated before calling this method.

HRESULT IDSSDataSource::Mode (  [out, retval] EnumDSSConnectionMode *  pMode  )

The tier mode corresponding to this data source. It is an enumeration, EnumDSSConnectionMode. The available values of EnumDSSConnectionMode are: DssConnectionModeDirectAccess 2-tier connection mode DssConnectionModeServerAccess 3-tier connection mode DssConnectionModeWebAccess 4-tier connection mode (Note: It is not supported now and is reserved for future expansion) Parameters: pMode  A pointer to an EnumDSSConnectionMode of the tier mode (client connection mode). Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the connection mode if the data source is initialized. E_POINTER Memory for pMode was not allocated before calling this method.

HRESULT IDSSDataSource::Name (  [in] BSTR  DataSourceName  )

The name of the data source. If the data source is added into an enumerator, put_Name returns error code CLNTCONN_E_DATASOURCE_NOT_INDEPENDENT. Parameters: DataSourceName  The name of the data source. Returns: Usual COM result code: S_OK DSSCOM_E_NULLSTRING Name is either null value or empty. CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the data source name if the data source is initialized. CLNTCONN_E_DATASOURCE_NOT_INDEPENDENT The data source is under at least one enumerator. Its name cannot be changed. E_POINTER Memory for pName was not allocated before calling this method.

HRESULT IDSSDataSource::Name (  [out, retval] BSTR *  pDataSourceName  )

The name of the data source. If the data source is added into an enumerator, put_Name returns error code CLNTCONN_E_DATASOURCE_NOT_INDEPENDENT. Parameters: pDataSourceName  A BSTR of the name of the data source. Returns: Usual COM result code: S_OK DSSCOM_E_NULLSTRING Name is either null value or empty. CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the data source name if the data source is initialized. CLNTCONN_E_DATASOURCE_NOT_INDEPENDENT The data source is under at least one enumerator. Its name cannot be changed. E_POINTER Memory for pName was not allocated before calling this method.

HRESULT IDSSDataSource::NewPasswd (  [in] BSTR  NewPasswd  )

Set a changed password to set during the next standard authentication. When this property is set, the ChangeOwnPassword method on IDSSUser will be performed to change the passwd of the login user during authentication of data source initialization. Parameters: NewPasswd  The password of the standard authentication. Returns: Usual COM result code: S_OK

HRESULT IDSSDataSource::NewPasswd (  [out, retval] BSTR *  pNewPasswd  )

Get a changed password to set during the next standard authentication. When this property is set, the ChangeOwnPassword method on IDSSUser will be performed to change the passwd of the login user during authentication of data source initialization. Parameters: pNewPasswd  A pointer to a BSTR of the password. Returns: Usual COM result code: S_OK E_POINTER Memory for pPassword was not allocated before calling this method.

HRESULT IDSSDataSource::passwd (  [in] BSTR  Passwd  )

HRESULT IDSSDataSource::passwd (  [out, retval] BSTR *  pPasswd  )

HRESULT IDSSDataSource::port (  [in] Int32  Port  )

HRESULT IDSSDataSource::port (  [out, retval] Int32 *  pPort  )

HRESULT IDSSDataSource::ProjectDescription (  [out, retval] BSTR *  pProjectDescription  )

The description of the project. Parameters: pProjectDescription  A pointer to the string that contains the description of the project. Returns: Usual COM result code: S_OK E_POINTER Memory for pProjectDescription was not allocated before calling this method.

HRESULT IDSSDataSource::ProjectID (  [in] BSTR  ProjectID  )

Set the ProjectID GUID of the project this data source represents. This property is only valid if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. It is optional. If not set, during data source initialization, data source retrieves it based on ProjectName. Parameters: ProjectID  The project ID. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the project ID if the data source is initialized. E_POINTER Memory for pProjectID was not allocated before calling this method.

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

Get the ProjectID GUID of the project this data source represents. This property is only valid if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. It is optional. If not set, during data source initialization, data source retrieves it based on ProjectName. Parameters: pProjectID  A pointer to the BSTR that contains the project ID. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the project ID if the data source is initialized. E_POINTER Memory for pProjectID was not allocated before calling this method.

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

The name of the project this data source represents. This property is only valid if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. Parameters: ProjectName  The name of the project. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the project Name if the data source is initialized. E_POINTER Memory for pProjectName was not allocated before calling this method.

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

The name of the project this data source represents. This property is only valid if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. Parameters: pProjectName  A pointer to the BSTR of the project name. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the project Name if the data source is initialized. E_POINTER Memory for pProjectName was not allocated before calling this method.

HRESULT IDSSDataSource::Reset (   )

Reset the data source. This method resets the data source to the state before Init() method is performed. After reset, the client can change the properties of the data source. The Reset method does nothing if it is called repeatedly. Returns: Usual COM result code: S_OK CLNTCONN_E_TIER_MODE_NOT_SET The connection mode is not set.

HRESULT IDSSDataSource::SaveToRegistry (  [in, optional] VARIANT_BOOL  OverWritten  )

Write the properties of this data source into the registry. This method writes the current data source into registry. If there is an existed information for this data source and OverWritten is 1, the existed information is replaced. If there is an existed information for this data source and OverWritten is 0, an error will be returned. Parameters: OverWritten  Determine whether to overwrite the existed information (default is False). Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_EXIST The data source is existed in the Registry. CLNTCONN_E_TIER_MODE_NOT_SET The connection mode is not set. CLNTCONN_E_VALUE_WRITE_FAILURE Failure to write values into the registry tree. E_OUTOFMEMORY Memory space is depleted.

HRESULT IDSSDataSource::ServerAdmin (  [out, retval] IDSSServerAdmin   ppServerAdmin  )

The ServerAdmin of this data source for a 3-tier or 4-tier connection. This property is only valid if Mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess. Parameters: ppServerAdmin  A pointer to the IDSSServerAdmin interface. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for ppServerAdmin was not allocated before calling this method.

HRESULT IDSSDataSource::ServerInstanceID (  [in] BSTR  ServerInstanceID  )

The ID of the DSS Server Definition object. The GUID of the ServerDef object that contains a collection of project references. This property is only valid if the mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeServer. It is optional. If not set, during data source initialization, data source retrieves it based on ServerInsatnceName. Parameters: ServerInstanceID  The GUID of the ServerDef object. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the GUID of ServerDef if the data source is initiaMlized. CLNTCONN_E_PROPERTY_GET_2TIER ServerInstanceID is a valid property only if the mode is DssConnectionModeDirectAccess. CLNTCONN_E_PROPERTY_GET_2TIER ServerInstanceID is a valid property only if the mode is DssConnectionModeDirectAccess. E_POINTER Memory for pServerInstanceID was not allocated before calling this method.

HRESULT IDSSDataSource::ServerInstanceID (  [out, retval] BSTR *  pServerInstanceID  )

The ID of the DSS Server Definition object. The GUID of the ServerDef object that contains a collection of project references. This property is only valid if the mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeServer. It is optional. If not set, during data source initialization, data source retrieves it based on ServerInsatnceName. Parameters: pServerInstanceID  A pointer to a BSTR that contains the GUID of the ServerDef object. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the GUID of ServerDef if the data source is initialized. CLNTCONN_E_PROPERTY_GET_2TIER ServerInstanceID is a valid property only if the mode is DssConnectionModeDirectAccess. CLNTCONN_E_PROPERTY_GET_2TIER ServerInstanceID is a valid property only if the mode is DssConnectionModeDirectAccess. E_POINTER Memory for pServerInstanceID was not allocated before calling this method.

HRESULT IDSSDataSource::ServerInstanceName (  [in] BSTR  ServerInstanceName  )

The name of the ServerDef object. The name of the ServerDef object that contains a collection of project references. This property is only valid if the mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeServer. Parameters: ServerInstanceName  The name of the ServerDef object Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the name of ServerDef if the data source is initialized. CLNTCONN_E_PROPERTY_GET_2TIER ServerInstanceName is a valid property only if the mode is DssConnectionModeDirectAccess CLNTCONN_E_PROPERTY_PUT_2TIER ServerInstanceName is a valid property only if the mode is DssConnectionModeDirectAccess E_POINTER Memory for pServerInstanceName was not allocated before calling this method

HRESULT IDSSDataSource::ServerInstanceName (  [out, retval] BSTR *  pServerInstanceName  )

The name of the ServerDef object. The name of the ServerDef object that contains a collection of project references. This property is only valid if the mode is DssConnectionModeDirectAccess and Type is DssDataSourceTypeServer. Parameters: pServerInstanceName  A pointer to a BSTR that contains the name of the ServerDef object Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the name of ServerDef if the data source is initialized. CLNTCONN_E_PROPERTY_GET_2TIER ServerInstanceName is a valid property only if the mode is DssConnectionModeDirectAccess CLNTCONN_E_PROPERTY_PUT_2TIER ServerInstanceName is a valid property only if the mode is DssConnectionModeDirectAccess E_POINTER Memory for pServerInstanceName was not allocated before calling this method

HRESULT IDSSDataSource::SessionFlags (  [in] EnumDSSSessionFlags  Flags  )

Set the session flags for this data source. It is used to indicate how to manage Inbox in 3-tier or 4-tier mode. It is a bit-wise enumeration type EnumDSSSessionFlags. The available enumerated values are: Constant Meaning DssSessionCancelActiveJobsOnClose Cancel all active jobs when session is closed DssSessionDeleteReadMsgsOnClose Delete all read messages when session is closed DssSessionDeleteUnreadMsgsOnClose Delete all unread messages when session is closed DssSessionPreserveFlags The user want to keep the flags value This property is only valid if the mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess. Parameters: Flags  The session flags of this data source. Returns: Usual COM result code: S_OK CLNTCONN_E_PROPERTY_PUT_34TIER The property is not available in a 2-tier data source. E_POINTER Memory for pSessionFlags was not allocated before calling this method.

HRESULT IDSSDataSource::SessionFlags (  [out, retval] EnumDSSSessionFlags *  pFlags  )

Get the session flags for this data source. It is used to indicate how to manage Inbox in 3-tier or 4-tier mode. It is a bit-wise enumeration type EnumDSSSessionFlags. The available enumerated values are: Constant Meaning DssSessionCancelActiveJobsOnClose Cancel all active jobs when session is closed DssSessionDeleteReadMsgsOnClose Delete all read messages when session is closed DssSessionDeleteUnreadMsgsOnClose Delete all unread messages when session is closed DssSessionPreserveFlags The user want to keep the flags value This property is only valid if the mode is DssConnectionModeServerAccess or DssConnectionModeWebAccess. Parameters: pFlags  A pointer to the session flags. Returns: Usual COM result code: S_OK CLNTCONN_E_PROPERTY_PUT_34TIER The property is not available in a 2-tier data source. E_POINTER Memory for pSessionFlags was not allocated before calling this method.

HRESULT IDSSDataSource::Timeout (  [in] Int32  Timeout  )

The client-server connection time out. It is only valid on a 3-tier or 4-tier data source. Parameters: Timeout  The connection time out. Returns: Usual COM result code: S_OK CLNTCONN_E_PROPERTY_PUT_34TIER The property is not available in a 2-tier data source. E_POINTER Memory for pTimeout was not allocated before calling this method.

HRESULT IDSSDataSource::Timeout (  [out, retval] Int32 *  pTimeout  )

The client-server connection time out. It is only valid on a 3-tier or 4-tier data source. Parameters: pTimeout  A pointer to the connection time out. Returns: Usual COM result code: S_OK CLNTCONN_E_PROPERTY_PUT_34TIER The property is not available in a 2-tier data source. E_POINTER Memory for pTimeout was not allocated before calling this method.

HRESULT IDSSDataSource::Type (  [in] EnumDSSDataSourceType  Type  )

Set the type of this data source. It indicates to which type of depository the data source points. It is an enumeration, EnumDSSDataSourceType. The available values of EnumDSSDataSourceType are: DssDataSourceTypeConfiguration points to a configuration in metadata (version 7) DssDataSourceTypeServer points to a server definition in 2-tier mode, points to a server in 3-tier and 4-tier mode DssDataSourceTypeProjectMD7 points to a project in metadata (version 7) DssDataSourceTypeProjectMD4 points to a project in metadata (version 6 (Abell)) Parameters: Type  The type of the data source. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the type of the data source if the data source is initialized. E_POINTER Memory for pType was not allocated before calling this method.

HRESULT IDSSDataSource::Type (  [out, retval] EnumDSSDataSourceType *  pType  )

Get the type of this data source. It indicates to which type of depository the data source points. It is an enumeration, EnumDSSDataSourceType. The available values of EnumDSSDataSourceType are: DssDataSourceTypeConfiguration points to a configuration in metadata (version 7) DssDataSourceTypeServer points to a server definition in 2-tier mode, points to a server in 3-tier and 4-tier mode DssDataSourceTypeProjectMD7 points to a project in metadata (version 7) DssDataSourceTypeProjectMD4 points to a project in metadata (version 6 (Abell)) Parameters: pType  A pointer to an EnumDSSDataSourceType of the type of data source. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the type of the data source if the data source is initialized. E_POINTER Memory for pType was not allocated before calling this method.

HRESULT IDSSDataSource::WebServerAdmin (  [out, retval] IDSSWebServerAdmin   ppWebServerAdmin  )

The WebServerAdmin of this data source (only for 4-tier mode). This property is only valid if Mode is DssConnectionModeWebAccess. Parameters: ppWebServerAdmin  A pointer to the IDSSWebServerAdmin interface. Returns: Usual COM result code: S_OK E_FAIL E_POINTER Memory for ppWebServerAdmin was not allocated before calling this method.

HRESULT IDSSDataSource::WHLogin (  [in] BSTR  Login  )

The login of warehouse database for pass through authentication. The warehouse login of pass through authentication if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one overwrites the one in the DSS file. Parameters: Login  The login of the warehouse database or pass through authentication. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the WHLogin if the data source is initialized. E_POINTER Memory for pWHLoginID was not allocated before calling this method.

HRESULT IDSSDataSource::WHLogin (  [out, retval] BSTR *  pLogin  )

The login of warehouse database for pass through authentication. The warehouse login of pass through authentication if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one overwrites the one in the DSS file. Parameters: pLogin  A pointer to a BSTR of the login. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the WHLogin if the data source is initialized. E_POINTER Memory for pWHLoginID was not allocated before calling this method.

HRESULT IDSSDataSource::WHPasswd (  [in] BSTR  Passwd  )

The password of warehouse database for pass through authentication. The warehouse password of pass through authentication if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. Passthrough authentication means that the user is authenticated by establishing a connection to the warehouse using this password. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one overwrites the one in the DSS file. Parameters: Passwd  The password of the warehouse database or the password of pass through authentication. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the WHPassword if the data source is initialized. E_POINTER Memory for pWHPassword was not allocated before calling this method.

HRESULT IDSSDataSource::WHPasswd (  [out, retval] BSTR *  pPasswd  )

The password of warehouse database for pass through authentication. The warehouse password of pass through authentication if Type is DssDataSourceTypeProjectMD4 or DssDataSourceTypeProjectMD7. Passthrough authentication means that the user is authenticated by establishing a connection to the warehouse using this password. If Type is DssDataSourceTypeProjectMD4, this property is optional if there is one in the DSS file. This one overwrites the one in the DSS file. Parameters: pPasswd  A pointer to a BSTR of the password. Returns: Usual COM result code: S_OK CLNTCONN_E_DATASOURCE_INITIALIZED Cannot change the WHPassword if the data source is initialized. E_POINTER Memory for pWHPassword was not allocated before calling this method.

---