Share via

UserDefinedDatatypes Collection

  • Article

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 UserDefinedDatatypes collection contains UserDefinedDatatype objects that reference a Microsoft SQL Server data integrity mechanism called a user-defined data type.

SQL-DMO object model that shows the current object

Properties

Count Property

Methods

Add Method

Refresh Method

Item Method

Remove Method (Collections)

ItemByID Method

 

Remarks

With the UserDefinedDatatypes collection, you can:

  • Create a new user-defined data type.
  • Remove a user-defined data type.

For more information about creating and removing user-defined data types by using the UserDefinedDatatype object and UserDefinedDatatypes collection, see UserDefinedDatatype Object.

When using the Item or Remove method, the UserDefinedDatatypes collection supports member identification using either name or ordinal reference syntax. For example:

Set oUDT = oDatabase.UserDefinedDatatypes("EmployeeID")

Or:

Set oUDT = oDatabase.UserDefinedDatatypes(2)

Additionally, when using name-based item selection, the Item method allows owner name qualification of the targeted SQL Server user-defined data type. For example:

Set oUDT = oDatabase.UserDefinedDatatypes("EmployeeID", "dbo")

When using the Remove method, the UserDefinedDatatypes collection does not support qualification of targeted object by owner name. It is suggested that you use the Item method to extract the target, and then use the Remove method of the UserDefinedDatatype object to drop a user-defined data type.

Note

Creating or removing SQL Server data integrity constraints implemented as user-defined data types by using the UserDefinedDatatypes collection requires appropriate privilege. The SQL Server login used for SQLServer object connection must be a member of the fixed role db_ddladmin or a role with greater privilege.