IFeed::Xml Method

  • Article

Returns the XML for the feed.

Syntax

HRESULT Xml(
    LONG count,
    FEEDS_XML_SORT_PROPERTY sortProperty,
    FEEDS_XML_SORT_ORDER sortOrder,
    FEEDS_XML_FILTER_FLAGS filterFlags,
    FEEDS_XML_INCLUDE_FLAGS includeFlags,
    BSTR *xml
);

Parameters

  • count
    [in] LONG value that specifies the maximum number of items to return. Pass FEEDS_XML_COUNT_MAX to return all the items in the feed.
  • sortProperty
    [in] A FEEDS_XML_SORT_PROPERTY value that defines the sort column.
  • sortOrder
    [in] A FEEDS_XML_SORT_ORDER value that defines the sort direction.
  • filterFlags
    [in] A FEEDS_XML_FILTER_FLAGS value that specifies whether to include items based on read status.
  • includeFlags
    [in] A FEEDS_XML_INCLUDE_FLAGS value that specifies whether to include namespace extensions to Really Simple Syndication (RSS) 2.0 in the XML.
  • xml
    [out, retval] Pointer to a BSTR that receives the XML source for the feed.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

If you specify FXSP_NONE in sortProperty, you must also specify FXSO_NONE in sortOrder and vice versa. If these values are not used together, this method will return E_INVALIDARG.

The user is responsible for freeing the memory with SysFreeString.

See Also

IFeedItem::Xml