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

IDSSXMLContext Interface Reference

Inherited by IDSSXMLContext2.

List of all members.

Detailed Description

Interface exposes properties and methods used to generate XML and provide contextual information.

This interface's main uses can be grouped under 2 main topics:


Public Member Functions

HRESULT AddElementToNode ([in] IDispatch *pNode,[in] BSTR Tag,[out, retval] IDispatch ppNode)
 Add a DOM element to a node.
HRESULT AddElementToParent ([in] BSTR Tag,[out, retval] IDispatch ppNode)
 Add a DOM element to the parent node.
HRESULT AddTextToNode ([in] IDispatch *pNode,[in] BSTR Text,[out, retval] IDispatch ppNode)
 Add a DOM text to the parent node.
HRESULT AddTextToParent ([in] BSTR Text,[out, retval] IDispatch ppNode)
 Add a DOM text to the parent node.
HRESULT AppendToInfo ([in] IDispatch *pElement,[in] IDSSObjectInfo *pObject,[in] Int32 RefID)
 Appends an element to the info node and mapping structures of the context.
HRESULT AppendToNode ([in] IDispatch *pNode,[in] IDispatch *pElement)
 Appends the element to the node.
HRESULT AppendToParent ([in] IDispatch *pElement)
 Appends an element to the parent node of the context.
HRESULT CreateElement ([in] BSTR Tag,[out, retval] IDispatch ppElement)
 Create an element in the document.
HRESULT DeltaPropXml ([in] IDispatch *pDeltaPropXml)
 The DeltaPropXML that should be applied.
HRESULT DeltaPropXml ([out, retval] IDispatch ppDeltaPropXml)
 The DeltaPropXML that should be applied.
HRESULT DeltaXml ([in] IDispatch *pDeltaXml)
 The DeltaXML that should be applied.
HRESULT DeltaXml ([out, retval] IDispatch ppDeltaXml)
 The DeltaXML that should be applied.
HRESULT Document ([in] IDispatch *pDocument)
 The XML document associated with this context.
HRESULT Document ([out, retval] IDispatch ppDocument)
 The XML document associated with this context.
HRESULT FindChild ([in] IDispatch *pElement,[in] BSTR Name,[out, retval] IDispatch ppChild)
 Find a child of a node with a given name.
HRESULT GetAttribute ([in] IDispatch *pElement,[in] BSTR Name,[out, retval] VARIANT *pValue)
 Get an attribute of an element.
HRESULT GraphHeight ([in] Int32 GraphHeight)
 The number of pixels that are used to as the height of the chart when a GIF is created.
HRESULT GraphHeight ([out, retval] Int32 *GraphpHeight)
 The number of pixels that are used to as the height of the chart when a GIF is created.
HRESULT GraphMaxCols ([in] Int32 MaxCols)
 The maximum number of cols that are displayed in a chart.
HRESULT GraphMaxCols ([out, retval] Int32 *pMaxCols)
 The maximum number of cols that are displayed in a chart.
HRESULT GraphMaxRows ([in] Int32 MaxRows)
 The maximum number of rows that are displayed in a chart.
HRESULT GraphMaxRows ([out, retval] Int32 *pMaxRows)
 The maximum number of rows that are displayed in a chart.
HRESULT GraphStartCol ([in] Int32 StartCol)
 The first col that are displayed in a chart.
HRESULT GraphStartCol ([out, retval] Int32 *pStartCol)
 The first col that are displayed in a chart.
HRESULT GraphStartRow ([in] Int32 StartRow)
 The first row that are displayed in a chart.
HRESULT GraphStartRow ([out, retval] Int32 *pStartRow)
 The first row that are displayed in a chart.
HRESULT GraphType ([in] Int32 GraphType)
 The type of graph that should be generated.
HRESULT GraphType ([out, retval] Int32 *pGraphType)
 The type of graph that should be generated.
HRESULT GraphWidth ([in] Int32 GraphWidth)
 The number of pixels that are used to as the width of the chart when a GIF is created.
HRESULT GraphWidth ([out, retval] Int32 *pGraphWidth)
 The number of pixels that are used to as the width of the chart when a GIF is created.
HRESULT GridStyle ([in] BSTR GridStyle)
 The style of the grid.
HRESULT GridStyle ([out, retval] BSTR *pGridStyle)
 The style of the grid.
HRESULT InfoNode ([in] IDispatch *pInfoNode)
 The current XML information node.
HRESULT InfoNode ([out, retval] IDispatch ppInfoNode)
 The current XML information node.
HRESULT Init ([in] IDispatch *pDocument,[in] IDispatch *pParentNode,[in] IDispatch *pInfoNode,[in] IDSSUserRuntime *pUserRuntime,[in] Int32 RefID,[in, defaultvalue(0)] Int32 Level,[in, defaultvalue(0)] BSTR MessageID,[in, defaultvalue(0)] IDispatch *pDeltaXml,[in, defaultvalue(0)] BSTR StyleXsl,[in, defaultvalue(-1)] Int32 ResultFlags,[in, defaultvalue(-1)] Int32 ViewIndex,[in, defaultvalue(-1)] Int32 StartRow,[in, defaultvalue(-1)] Int32 MaxRows,[in, defaultvalue(-1)] Int32 StartCol,[in, defaultvalue(-1)] Int32 MaxCols,[in, defaultvalue(-1)] Int32 GraphType,[in, defaultvalue(-1)] Int32 GraphHeight,[in, defaultvalue(-1)] Int32 GraphWidth,[in, defaultvalue(0)] BSTR GridStyle,[in, defaultvalue(-1)] Int32 GraphStartRow,[in, defaultvalue(-1)] Int32 GraphMaxRows,[in, defaultvalue(-1)] Int32 GraphStartCol,[in, defaultvalue(-1)] Int32 GraphMaxCols,[in, defaultvalue(0)] IDispatch *pDeltaPropXml)
 Initializes many of the methods on the context.
HRESULT LastNode ([in] IDispatch *pLastNode)
 The last XML node added to the context.
HRESULT LastNode ([out, retval] IDispatch ppLastNode)
 The last XML node added to the context.
HRESULT Level ([in] Int32 Level)
 Level associated with this context.
HRESULT Level ([out, retval] Int32 *pLevel)
 Level associated with this context.
HRESULT Locale ([in] Int32 Locale)
 Locale of the XML context.
HRESULT Locale ([out, retval] Int32 *pLocale)
 Locale of the XML context.
HRESULT LookupObject ([in] IDSSObjectInfo *pObject,[out] Int32 *pRefID,[out, retval] IDispatch ppElement)
 Returns the reference ID and DOM node associated with a particular object.
HRESULT MaxCols ([in] Int32 MaxCols)
 The maximum number of columns that are displayed in a grid.
HRESULT MaxCols ([out, retval] Int32 *pMaxCols)
 The maximum number of columns that are displayed in a grid.
HRESULT MaxRows ([in] Int32 MaxRows)
 The maximum number of rows that are displayed in a grid.
HRESULT MaxRows ([out, retval] Int32 *pMaxRows)
 The maximum number of rows that are displayed in a grid.
HRESULT MessageID ([in] BSTR MessageID)
 MessageID associated with the command.
HRESULT MessageID ([out, retval] BSTR *pMessageID)
 MessageID associated with the command.
HRESULT ParentNode ([in] IDispatch *pParentNode)
 The current XML parent node.
HRESULT ParentNode ([out, retval] IDispatch ppParentNode)
 The current XML parent node.
HRESULT RefID ([in] Int32 RefID)
 The current reference ID.
HRESULT RefID ([out, retval] Int32 *pRefID)
 The current reference ID.
HRESULT ResultFlags ([in] Int32 ResultFlags)
 Miscellaneous flags used to specify what content should be included in generated XML.
HRESULT ResultFlags ([out, retval] Int32 *pResultFlags)
 Miscellaneous flags used to specify what content should be included in generated XML.
HRESULT SetAttribute ([in] IDispatch *pElement,[in] BSTR Attribute,[in] VARIANT *pValue)
 Sets the attribute on an element.
HRESULT StartCol ([in] Int32 StartCol)
 The first column that are displayed in a grid.
HRESULT StartCol ([out, retval] Int32 *pStartCol)
 The first column that are displayed in a grid.
HRESULT StartRow ([in] Int32 StartRow)
 The first row that are displayed in a grid.
HRESULT StartRow ([out, retval] Int32 *pStartRow)
 The first row that are displayed in a grid.
HRESULT StyleXsl ([in] BSTR StyleXsl)
 The XSL style that should be applied.
HRESULT StyleXsl ([out, retval] BSTR *pStyleXsl)
 The XSL style that should be applied.
HRESULT UserRuntime ([in] IDSSUserRuntime *pUserRuntime)
 The user runtime for this XML operation.
HRESULT UserRuntime ([out, retval] IDSSUserRuntime ppUserRuntime)
 The user runtime for this XML operation.
HRESULT ViewIndex ([in] Int32 ViewIndex)
 The index number of the view template.
HRESULT ViewIndex ([out, retval] Int32 *pViewIndex)
 The index number of the view template.

Member Function Documentation

HRESULT IDSSXMLContext::AddElementToNode (  [in] IDispatch *  pNode,
[in] BSTR  Tag,
[out, retval] IDispatch   ppNode
) 
 

Add a DOM element to a node.

Creates a new node (ppNode), with tag (Tag) under pNode. Part of wrapper group.

Document property of the context has to be set before the call.
Parameters:
pNode Element which is the parent of the new node.
Tag Tag for the new node.
ppNode Pointer to the new node.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::AddElementToParent (  [in] BSTR  Tag,
[out, retval] IDispatch   ppNode
) 
 

Add a DOM element to the parent node.

This method is a part of the wrapper group. It creates an XMLDOMElement using the Document property and appends it to the node pointed by the ParentNode property.

Document and ParentNode properties of the context have to be set before the call.
Parameters:
Tag Tag name of the new element node to add
ppNode IDispatch interface to the new node added in case of sucess
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::AddTextToNode (  [in] IDispatch *  pNode,
[in] BSTR  Text,
[out, retval] IDispatch   ppNode
) 
 

Add a DOM text to the parent node.

This method is a part of the wrapper group. It creates an XMLDOMText using the Document property and appends it to the node sent in through the parameters. Part of wrapper group.

Document property of the context has to be set before the call.
Parameters:
pNode Node of the document to add the text to
Text Text to add to the node
ppNode Text node added by the method. Could be NULL.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::AddTextToParent (  [in] BSTR  Text,
[out, retval] IDispatch   ppNode
) 
 

Add a DOM text to the parent node.

Part of wrapper group.

Document and ParentNode properties of the context have to be set before the call.
Parameters:
Text Text to add to parent node
ppNode Pointer to text node that has been added to the parent node
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::AppendToInfo (  [in] IDispatch *  pElement,
[in] IDSSObjectInfo *  pObject,
[in] Int32  RefID
) 
 

Appends an element to the info node and mapping structures of the context.

This method adds the sent in XMLDOMElement to the Info node of the XMLContext. It also adds the object with this element, and the sent in Ref ID to the internal mapping structures that can be looked up later using LookUpObject method.

InfoNode property of the context has to be set before the call.
Parameters:
pElement Info node to add.
pObject DSS Object to get its DSS_ID
RefID Reference ID for this object and node.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::AppendToNode (  [in] IDispatch *  pNode,
[in] IDispatch *  pElement
) 
 

Appends the element to the node.

This method is a part of the wrapper group. It appends the send in element (second parameter) to the node (first parameter).

Parameters:
pNode Node to add to
pElement Element that will be appended to pNode
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::AppendToParent (  [in] IDispatch *  pElement  ) 
 

Appends an element to the parent node of the context.

This method is very similar to AppendToNode method. It's a shortcut to add an existing XMLDOMElement to ParentNode directly.

ParentNode property of the context has to be set before the call.
Parameters:
pElement Element that will be appended to ParentNode
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::CreateElement (  [in] BSTR  Tag,
[out, retval] IDispatch   ppElement
) 
 

Create an element in the document.

This method is a part of the wrapper group. It creates the element with the sent in tag using the Document.

Document property of the context has to be set before the call.
Parameters:
Tag Tag of the element to create
ppElement Newly created element in case of success.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::DeltaPropXml (  [in] IDispatch *  pDeltaPropXml  ) 
 

The DeltaPropXML that should be applied.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::DeltaPropXml (  [out, retval] IDispatch   ppDeltaPropXml  ) 
 

The DeltaPropXML that should be applied.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::DeltaXml (  [in] IDispatch *  pDeltaXml  ) 
 

The DeltaXML that should be applied.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::DeltaXml (  [out, retval] IDispatch   ppDeltaXml  ) 
 

The DeltaXML that should be applied.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::Document (  [in] IDispatch *  pDocument  ) 
 

The XML document associated with this context.

This property is a part of the context group. It is used in many other methods to create elements, text nodes, attributes, etc.

Parameters:
pDocument Document to set on the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::Document (  [out, retval] IDispatch   ppDocument  ) 
 

The XML document associated with this context.

This property is a part of the context group. It is used in many other methods to create elements, text nodes, attributes, etc.

Parameters:
ppDocument Pointer to current document of the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::FindChild (  [in] IDispatch *  pElement,
[in] BSTR  Name,
[out, retval] IDispatch   ppChild
) 
 

Find a child of a node with a given name.

This method is a part of the wrapper group. In the hierarchical structure of XML nodes, it tries to find the first child node (ppChild) under the sent in node (pElement) that has the sent in tag (Name).

Parameters:
pElement Element to look under
Name Tag name to search for
ppChild Return value
Returns:
Usual COM result code:
  • S_OK
  • S_FALSE This is returned if the child with the given tag name is not found

HRESULT IDSSXMLContext::GetAttribute (  [in] IDispatch *  pElement,
[in] BSTR  Name,
[out, retval] VARIANT *  pValue
) 
 

Get an attribute of an element.

This method is a part of the wrapper group. It returns the value of the asked attribute as a BSTR in the sent in VARIANT.

Parameters:
pElement Element to search for attribute
Name Name of the attribute
pValue Value of the attribute as BSTR
Returns:
Usual COM result code:
  • S_OK
  • S_FALSE This will be returned if the attribute with the given name is not found

HRESULT IDSSXMLContext::GraphHeight (  [in] Int32  GraphHeight  ) 
 

The number of pixels that are used to as the height of the chart when a GIF is created.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphHeight (  [out, retval] Int32 *  GraphpHeight  ) 
 

The number of pixels that are used to as the height of the chart when a GIF is created.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphMaxCols (  [in] Int32  MaxCols  ) 
 

The maximum number of cols that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphMaxCols (  [out, retval] Int32 *  pMaxCols  ) 
 

The maximum number of cols that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphMaxRows (  [in] Int32  MaxRows  ) 
 

The maximum number of rows that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphMaxRows (  [out, retval] Int32 *  pMaxRows  ) 
 

The maximum number of rows that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphStartCol (  [in] Int32  StartCol  ) 
 

The first col that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphStartCol (  [out, retval] Int32 *  pStartCol  ) 
 

The first col that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphStartRow (  [in] Int32  StartRow  ) 
 

The first row that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphStartRow (  [out, retval] Int32 *  pStartRow  ) 
 

The first row that are displayed in a chart.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphType (  [in] Int32  GraphType  ) 
 

The type of graph that should be generated.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphType (  [out, retval] Int32 *  pGraphType  ) 
 

The type of graph that should be generated.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphWidth (  [in] Int32  GraphWidth  ) 
 

The number of pixels that are used to as the width of the chart when a GIF is created.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GraphWidth (  [out, retval] Int32 *  pGraphWidth  ) 
 

The number of pixels that are used to as the width of the chart when a GIF is created.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GridStyle (  [in] BSTR  GridStyle  ) 
 

The style of the grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::GridStyle (  [out, retval] BSTR *  pGridStyle  ) 
 

The style of the grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::InfoNode (  [in] IDispatch *  pInfoNode  ) 
 

The current XML information node.

This property is a part of the context group. It is a pointer to the parent node of a set of object_info nodes.

If the previous value of this property was Nothing when it is set, it triggers a piece of code that initializes the internal mapping structures according to the children of the sent in parameter. These structures can be used through LookUpObject method.
Parameters:
pInfoNode Current info node of the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::InfoNode (  [out, retval] IDispatch   ppInfoNode  ) 
 

The current XML information node.

This property is a part of the context group. It is a pointer to the parent node of a set of object_info nodes.

If the previous value of this property was Nothing when it is set, it triggers a piece of code that initializes the internal mapping structures according to the children of the sent in parameter. These structures can be used through LookUpObject method.
Parameters:
ppInfoNode Pointer to current info node of the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::Init (  [in] IDispatch *  pDocument,
[in] IDispatch *  pParentNode,
[in] IDispatch *  pInfoNode,
[in] IDSSUserRuntime *  pUserRuntime,
[in] Int32  RefID,
[in, defaultvalue(0)] Int32  Level,
[in, defaultvalue(0)] BSTR  MessageID,
[in, defaultvalue(0)] IDispatch *  pDeltaXml,
[in, defaultvalue(0)] BSTR  StyleXsl,
[in, defaultvalue(-1)] Int32  ResultFlags,
[in, defaultvalue(-1)] Int32  ViewIndex,
[in, defaultvalue(-1)] Int32  StartRow,
[in, defaultvalue(-1)] Int32  MaxRows,
[in, defaultvalue(-1)] Int32  StartCol,
[in, defaultvalue(-1)] Int32  MaxCols,
[in, defaultvalue(-1)] Int32  GraphType,
[in, defaultvalue(-1)] Int32  GraphHeight,
[in, defaultvalue(-1)] Int32  GraphWidth,
[in, defaultvalue(0)] BSTR  GridStyle,
[in, defaultvalue(-1)] Int32  GraphStartRow,
[in, defaultvalue(-1)] Int32  GraphMaxRows,
[in, defaultvalue(-1)] Int32  GraphStartCol,
[in, defaultvalue(-1)] Int32  GraphMaxCols,
[in, defaultvalue(0)] IDispatch *  pDeltaPropXml
) 
 

Initializes many of the methods on the context.

This method can be used to set almost all of the properties of the XML context at once. Please note that it directly sets the parent and info nodes, and doesn't do the special cases handling mentioned in the of ParentNode, and InfoNode properties.

Returns:
Usual COM result code:

HRESULT IDSSXMLContext::LastNode (  [in] IDispatch *  pLastNode  ) 
 

The last XML node added to the context.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::LastNode (  [out, retval] IDispatch   ppLastNode  ) 
 

The last XML node added to the context.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::Level (  [in] Int32  Level  ) 
 

Level associated with this context.

Part of context group. Internally takes its value from IDSSObjectInfo.SaveToXMLDOM parameter.

Parameters:
Level Level to be set on XML context.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::Level (  [out, retval] Int32 *  pLevel  ) 
 

Level associated with this context.

Part of context group. Internally takes its value from IDSSObjectInfo.SaveToXMLDOM parameter.

Parameters:
pLevel Pointer to current Level of the XML context
Returns:
Usual COM result code:
  • S_OK

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

Locale of the XML context.

This property is a part of the context group. It holds the locale of the web client (as defined by Windows NT operating system), so that operations like number and date formatting, and parsing can be handled correctly.

It's default value is LOCALE_USER_DEFAULT and it can be affected by setting the user runtime, as user runtime also holds a locale.
Parameters:
Locale Current Locale on the context
Returns:
Usual COM result code:
  • S_OK

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

Locale of the XML context.

This property is a part of the context group. It holds the locale of the web client (as defined by Windows NT operating system), so that operations like number and date formatting, and parsing can be handled correctly.

It's default value is LOCALE_USER_DEFAULT and it can be affected by setting the user runtime, as user runtime also holds a locale.
Parameters:
pLocale Pointer to XML context's current locale
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::LookupObject (  [in] IDSSObjectInfo *  pObject,
[out] Int32 *  pRefID,
[out, retval] IDispatch   ppElement
) 
 

Returns the reference ID and DOM node associated with a particular object.

This is done using the internal mapping structures mentioned in InfoNode property.

Parameters:
pObject Object to look up under info_node.
pRefID Ref ID of the object if found.
ppElement DOM node of the object if found.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::MaxCols (  [in] Int32  MaxCols  ) 
 

The maximum number of columns that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::MaxCols (  [out, retval] Int32 *  pMaxCols  ) 
 

The maximum number of columns that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::MaxRows (  [in] Int32  MaxRows  ) 
 

The maximum number of rows that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::MaxRows (  [out, retval] Int32 *  pMaxRows  ) 
 

The maximum number of rows that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::MessageID (  [in] BSTR  MessageID  ) 
 

MessageID associated with the command.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::MessageID (  [out, retval] BSTR *  pMessageID  ) 
 

MessageID associated with the command.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::ParentNode (  [in] IDispatch *  pParentNode  ) 
 

The current XML parent node.

Part of the "context group".

If the previous value of this property was Nothing when it is set, and the in parameter is the node pointer for an msi_item, the InfoNode is searched under it, and set if found. This may initialize the internal mapping structures. These structures can be used through LookUpObject method.
Parameters:
pParentNode Parent node to be set on XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::ParentNode (  [out, retval] IDispatch   ppParentNode  ) 
 

The current XML parent node.

Part of the "context group".

If the previous value of this property was Nothing when it is set, and the in parameter is the node pointer for an msi_item, the InfoNode is searched under it, and set if found. This may initialize the internal mapping structures. These structures can be used through LookUpObject method.
Parameters:
ppParentNode Pointer to current parent node of the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::RefID (  [in] Int32  RefID  ) 
 

The current reference ID.

Reference IDs can be used as a way of mapping between the object fererences, and/or XML, and children of InfoNode. This property sets a starting reference ID for the XML generation. Part of the context group.

Parameters:
RefID Ref ID to be set on XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::RefID (  [out, retval] Int32 *  pRefID  ) 
 

The current reference ID.

Reference IDs can be used as a way of mapping between the object fererences, and/or XML, and children of InfoNode. This property sets a starting reference ID for the XML generation. Part of the context group.

Parameters:
pRefID Pointer to current Ref ID of the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::ResultFlags (  [in] Int32  ResultFlags  ) 
 

Miscellaneous flags used to specify what content should be included in generated XML.

ResultFlags that specifies the pieces of information required in report instance XML. Its values are set by a bitwise OR of EnumDSSXMLResultFlags enumeration values.

Parameters:
ResultFlags Result falg to be set on XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::ResultFlags (  [out, retval] Int32 *  pResultFlags  ) 
 

Miscellaneous flags used to specify what content should be included in generated XML.

ResultFlags that specifies the pieces of information required in report instance XML. Its values are set by a bitwise OR of EnumDSSXMLResultFlags enumeration values.

Parameters:
pResultFlags Pointer to current result flag of the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::SetAttribute (  [in] IDispatch *  pElement,
[in] BSTR  Attribute,
[in] VARIANT *  pValue
) 
 

Sets the attribute on an element.

An attribute with name (Attribute) and value (pValue) is set on (pElement). Part of wrapper group.

Parameters:
pElement Parent node of this attribute
Attribute Attribute name to be created/set.
pValue Value for the attribute
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::StartCol (  [in] Int32  StartCol  ) 
 

The first column that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::StartCol (  [out, retval] Int32 *  pStartCol  ) 
 

The first column that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::StartRow (  [in] Int32  StartRow  ) 
 

The first row that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::StartRow (  [out, retval] Int32 *  pStartRow  ) 
 

The first row that are displayed in a grid.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::StyleXsl (  [in] BSTR  StyleXsl  ) 
 

The XSL style that should be applied.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::StyleXsl (  [out, retval] BSTR *  pStyleXsl  ) 
 

The XSL style that should be applied.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::UserRuntime (  [in] IDSSUserRuntime *  pUserRuntime  ) 
 

The user runtime for this XML operation.

The privileges for operations, and access rights on objects are based on this property. Part of the context group.

Parameters:
pUserRuntime User runtime to be set on XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::UserRuntime (  [out, retval] IDSSUserRuntime   ppUserRuntime  ) 
 

The user runtime for this XML operation.

The privileges for operations, and access rights on objects are based on this property. Part of the context group.

Parameters:
ppUserRuntime Pointer to current user runtime of the XML context
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::ViewIndex (  [in] Int32  ViewIndex  ) 
 

The index number of the view template.

Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSXMLContext::ViewIndex (  [out, retval] Int32 *  pViewIndex  ) 
 

The index number of the view template.

Returns:
Usual COM result code:
  • S_OK

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