XMLPublications.changeFormatState (Method)
Changes the state of an XML publication format to active or inactive.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| formatID | XMLPublicationFormatID | Required | The ID of an XML publication format. |
| state | XMLPublicationState | Required | String identifying a state for an XML publication format: 'Active' or 'Inactive'. |
Context:
| License Requirements | XMLPublication |
| Permission Requirements | site:ManageXMLPublications |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 65017 | You cannot change the state of the specified XML publication format as it is associated with an inactive publication definition. |
Notes:
None