XMLPublications.getDefinitionList (Method)

Returns zero or more structures, each containing information on an XML publication. Structure members contain information on an XML feed's ID, name, state, and a publication count.

Returns:

XMLPublications_GetDefinitionList_Result (query)

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

Field Name Type Description
Description Any The publication definition's description.
ID Any The publication definition's ID.
Name Any The publication definition's name.
State XMLPublicationState The publication definition's state.
XMLPublicationsCount Any The number of XML publications (feeds) based on this publication definition.

Arguments:

Name Type Required Description
id XMLPublicationDefinitionID_0 Optional. Defaults to '0'. The ID of an XML publication definition. If this value is 0, CommonSpot returns information for all XML publications.
state GeneralStateFilter Optional. Defaults to 'All'. The state of an XML publication, either 'All', 'Active' or 'Inactive'.

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