ReplicationAddColumn Method
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The ReplicationAddColumn method adds a column to a table published in one or more publications.
Syntax
object
.ReplicationAddColumn(
ColumnName
,
TypeText
,
PublicationName
,
[
SchemaChangeScript
]
)
Parts
- object
Expression that evaluates to an object in the Applies To list.
- ColumnName
Name of the column to be added. The column is added to the table if the method succeeds, regardless of what is specified in PublicationName.
- TypeText
String containing the syntax that follows the column_name parameter in the ALTER TABLE statement in Transact-SQL.
- PublicationName
String naming publications to which the column is to be added.
- SchemaChangeScript
Optional string that specifies a schema change script to propagate to the subscriber. Valid for transactional replication only. Default is NULL.
Prototype (C/C++)
HRESULT ReplicationAddColumn(
SQLDMO_LPCSTR pszColumnName,
SQLDMO_LPCSTR pszTypeText,
SQLDMO_LPCSTR pszPublicationName
SQLDMO_LPCSTR pszSchemaChangeScript);
Remarks
ReplicationAddColumn adds the column specified by the ColumnName parameter to the table represented by the ReplicationTable object, and to publications specified by the PublicationName parameter. If PublicationName is set to 'all', the column is added to all publications. If PublicationName is set to 'none', the column is not added to any publication. Otherwise, set PublicationName as a string that names publications in the format '[pub1],[pub2],[pub2]'.
Note
If an application calls ReplicationAddColumn on an instance of SQL Server version 7.0, the constant, SQLDMO_E_SQL80ONLY, and the message "This property or method requires Microsoft SQL Server 2000 or later" are returned.
Applies To:
See Also
Reference
Other Resources
Making Schema Changes on Publication Databases