Set the property of an existing publication in the data dictionary.
Syntax
sp_ModifyPublicationProperty(
PublicationName,CHARACTER,200,
Property,CHARACTER,200,
Value,Memo )
Parameters
PublicationName (I) |
The name of the publication in the database. |
Property (I) |
Name of the property to set. See Remarks for allowed values. |
Value (I) |
Value to be stored in the data dictionary in string format. |
Special Return Codes
AE_INVALID_PROPERTY_ID |
Either the value supplied in Property is not a valid publication property, or the specified property cannot be modified. |
AE_INVALID_OBJECT_NAME |
The publication specified by PublicationName cannot be located in the data dictionary. |
Remarks
sp_ModifyPublicationProperty sets one property for the specified publication in the database. The new property overwrites the existing property in the data dictionary. The following are the valid values for Property.
Property |
Description |
COMMENT |
Changes the publication description. |
OPTIONS |
This is reserved for future use. |
USER_DEFINED_PROP |
Changes the user defined publication property. The user-defined property is set, read, and interpreted by the application. It is not used by Advantage. |
Example
EXECUTE PROCEDURE sp_ModifyPublicationProperty( 'mypub', 'comment',
'this is a test publication' )
See Also