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

IDSSFeatureFlag Interface Reference

Inherited by IDSSFeatureFlag2.

List of all members.

Public Member Functions

HRESULT Disclaimer ([in] BSTR iDisclaimer)
 Put the disclaimer to the Feature Flag Object.
HRESULT Disclaimer ([out, retval] BSTR *opDisclaimer)
 Get the disclaimer from the Feature Flag Object.
HRESULT FeatureStatus ([in] EnumDSSFeatureFlagStatus iFeatureStatus)
 Set the Feature status on the Feature Flag Object.
HRESULT FeatureStatus ([out, retval] EnumDSSFeatureFlagStatus *opFeatureStatus)
 Get the Feature status from the Feature Flag Object.
HRESULT Info ([out, retval] IDSSObjectInfo oppInfo)
 Get the ObjectInfo of the Feature Flag Object.
HRESULT IsDefaultOn ([in] VARIANT_BOOL iDefaultOn)
 Set the default status on the Feature Flag Object.
HRESULT IsDefaultOn ([out, retval] VARIANT_BOOL *opDefaultOn)
 Check whether the default status of the Feature Flag Object is on or off.
HRESULT IsExternal ([in] VARIANT_BOOL iExternal)
 Set the internal value on the feature.
HRESULT IsExternal ([out, retval] VARIANT_BOOL *opExternal)
 Check if the feature is an internal feature.
HRESULT MultilingualDisclaimer ([out, retval] IDSSMultilingualString oppDisclaimer)
 Get the multiingual disclaimer from the Feature Flag Object.


Member Function Documentation

HRESULT IDSSFeatureFlag::Disclaimer [in] BSTR  iDisclaimer  ) 
 

Put the disclaimer to the Feature Flag Object.

Parameters:
iDisclaimer BSTR to hold the disclaimer string.
Returns:
Usual COM result code.

HRESULT IDSSFeatureFlag::Disclaimer [out, retval] BSTR *  opDisclaimer  ) 
 

Get the disclaimer from the Feature Flag Object.

Parameters:
opDisclaimer BSTR to hold the disclaimer string.
Returns:
Usual COM result code.

HRESULT IDSSFeatureFlag::FeatureStatus [in] EnumDSSFeatureFlagStatus  iFeatureStatus  ) 
 

Set the Feature status on the Feature Flag Object.

Parameters:
iFeatureStatus Enum EnumDSSFeatureFlagStatus to indicate the feature status.

HRESULT IDSSFeatureFlag::FeatureStatus [out, retval] EnumDSSFeatureFlagStatus opFeatureStatus  ) 
 

Get the Feature status from the Feature Flag Object.

Parameters:
opFeatureStatus to hold the returned feature status.
Returns:
Usual COM result code.

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

Get the ObjectInfo of the Feature Flag Object.

From the info, we can get internal/external feature name, feature description.

Parameters:
oppInfo interface to hold the ObjectInfo.
Returns:
Usual COM result code.

HRESULT IDSSFeatureFlag::IsDefaultOn [in] VARIANT_BOOL  iDefaultOn  ) 
 

Set the default status on the Feature Flag Object.

Parameters:
iDefaultOn bool to represent the true/false of the default status.
Returns:
Usual COM result code.

HRESULT IDSSFeatureFlag::IsDefaultOn [out, retval] VARIANT_BOOL *  opDefaultOn  ) 
 

Check whether the default status of the Feature Flag Object is on or off.

Parameters:
opDefaultOn to hold the returned default value.
Returns:
Usual COM result code.

HRESULT IDSSFeatureFlag::IsExternal [in] VARIANT_BOOL  iExternal  ) 
 

Set the internal value on the feature.

Parameters:
iExternal bool to indicate if we want to set the feature as internal or not.
Returns:
Usual COM result code.

HRESULT IDSSFeatureFlag::IsExternal [out, retval] VARIANT_BOOL *  opExternal  ) 
 

Check if the feature is an internal feature.

We should not expose the feature to customer if it's an internal one. opExternal bool value to indicate whether the feature is internal or not:

  • true internal feature.
  • false public feature.
    Returns:
    Usual COM result code.

HRESULT IDSSFeatureFlag::MultilingualDisclaimer [out, retval] IDSSMultilingualString   oppDisclaimer  ) 
 

Get the multiingual disclaimer from the Feature Flag Object.

Parameters:
oppDisclaimer to hold the multilingual string.
Returns:
Usual COM result code.


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