• Article

UserDefinedFunctions Collection

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 UserDefinedFunctions collection contains UserDefinedFunction objects that reference the Microsoft SQL Server user-defined functions.

SQL-DMO object model that shows the current object

Remarks

With the UserDefinedFunctions collection, you can:

  • Create a user-defined function.

  • Remove a user-defined function.

For more information about creating user-defined functions by using the UserDefinedFunction object and UserDefinedFunctions collection, see UserDefinedFunction Object.

To remove a user-defined function

  1. Use the Item or ItemByID method to reference the targeted user-defined function through the UserDefinedFunction object in the UserDefinedFunctions collection. When extracting a UserDefinedFunction object using the name of the referenced user-defined function, use the owner name to qualify the name, as in:

    Set oUDF = _
oDatabase.UserDefinedFunctions("SummarizeSales", "dbo")

  2. Use the Remove method of the UserDefinedFunction object to remove the targeted user-defined function.

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

Set oUDF = _
oDatabase.UserDefinedFunctions("SummarizeSales", "dbo").Remove

Or:

Set oUDF = oDatabase.UserDefinedFunctions(1).Remove

Additionally, when using name-based item selection, the Item method allows qualification by owner name of the targeted SQL Server user-defined function, as shown earlier. When using the Remove method, the UserDefinedFunctions collection supports qualification of the targeted object by owner name if the Remove method contains a string with a valid owner name as a parameter. If the Remove method contains an integer as a parameter, no owner name can be specified. In this case, it is suggested that you use the Item method to extract the target, and then use the Remove method of the UserDefinedFunction object to drop a user-defined function.

Note

Creating or removing SQL Server user-defined functions by using the UserDefinedFunctions collection requires appropriate permissions.

Note

The UserDefinedFunctions collection is not compatible with SQL Server version 7.0 or earlier.