XMLPublications.getFormatList (Method)

Returns zero or more structures, each containing information about an XML publication format. Structure members include a description, feed count, name, and so on.

Returns:

XMLPublications_GetFormatList_Result (query)

Each row of the returned query results has the following fields:

Field Name	Type	Description
Description	PlainText	The XML publication format's description.
FeedCount	NonNegativeInteger	The number of feeds that are using this format.
ID	XMLPublicationFormatID	The XML publication format's ID.
Name	PlainText_NonNull	The XML publication format's name.
publicationDefinitionID	XMLPublicationDefinitionID	The publication definition's ID.
publicationDefinitionName	PlainText	The publication definition's name.
State	XMLPublicationState	The XML publication format's state, either 'Active' or 'Inactive'.
syndicationType	SyndicationType_EmptyString	The syndication type (0--application/atom+xml--or 1--application/rss+xml) or an empty string to indicate this is not a syndication format.
XSLModule	PlainText	The XSL module.
XSLModuleType	XSLTModuleType_EmptyString	The XSL module type.

Arguments:

Name	Type	Required	Description
id	XMLPublicationFormatID_0	Optional. Defaults to '0'.	The ID of an XML publication format ID. If this value is 0, CommonSpot returns information on all XML publication formats.
state	GeneralStateFilter	Optional. Defaults to 'All'.	The state of the XML publication's format, which can be 'All', 'Active' or 'Inactive'. This argument is ignored if this method's 'id' argument is not zero.

Context:

License Requirements	None
Permission Requirements	ContributorOrServerCode
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	This method may be customized at the site level

Error Codes:

None

Notes:

None