KB7352: How to Retrieve Element Value for a Filter Expression Using the MicroStrategy Intelligence Server SDK 9.x

 
If the element values are desired from the filter expression, the IDSSElement::Text API call should be used.
 
IDSSElement::Text
Return the value of the element in a given attribute base form. The value is returned as a BSTR. The client may ask for any form, but it is more efficient to indicate in advance which forms is required, by calling the AddForm method on IDSSElements.

HRESULT get_Text( 
    long BaseFormID, 
    BSTR Format, 
    long Locale, 
    BSTR * pText 
);

 
In Parameters:

• BaseFormID - Index of the base form.
• Format - Optional format string for the text value. This is useful if the value is a number or date.
• Locale - Locale ID (LCID). This determines the locale used to format the string.

 
Out Parameters:

• pText - The result, as a BSTR.

 
Return Values:

S_OK 

 
The only required input parameter is the base form ID. It can be retrieved from the attribute browse form information stored with IDSSElement::Attribute. The code sample below displays the element values based on browse forms defined for the attribute. After running the code against the sample filter mentioned above, the element information appears on the message box in sequence:

Aaronson 
Maxwell 
Abarca 
Hugh

 

'Assume you already have filter located in myFilter object 
Dim i 
Dim oElements As IDSSElements 
Dim oElement As IDSSElement 
Dim oAttributeForm As IDSSAttributeForm 

For i = 1 To MyFilter.Expression.Root.Count ' go through all children of root node 

    If MyFilter.Expression.Root.Item(i).Type = DssNodeElementsObject Then 
         Set oElements = MyFilter.Expression.Root.Item(i).Special.Elements 

         For Each oElement In oElements 
              For Each oAttributeForm In oElement.Attribute.BrowseForms 
                   If Not 
                        oAttributeForm.BaseAttributeForm Is Nothing Then 
                        MsgBox oElement.Text(oAttributeForm.BaseAttributeForm.BaseFormID) 
                    End If 
              Next 
          Next 
     End If 
Next

The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.microstrategy.com).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.microstrategy.com/us/services/support/contact.
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.