• Article

UserDefinedFunction Object

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 UserDefinedFunction object exposes the attributes of a single user-defined function.

SQL-DMO object model that shows the current object

Remarks

With the UserDefinedFunction object, you can:

  • Create a Microsoft SQL Server user-defined function.

  • Change the definition of an existing SQL Server user-defined function.

  • Control access rights to an existing SQL Server user-defined function.

  • Delete an existing SQL Server user-defined function.

  • Generate a Transact-SQL script to re-create a SQL Server user-defined function.

The Name property of a UserDefinedFunction object uses the SQL Server sysname data type. The value of the Name property must be unique (named by owner) within a SQL Server database.

To create a SQL Server user-defined function

  1. Create a UserDefinedFunction object.

  2. Set the Name property.

  3. Set the Text property to contain the user-defined function.

  4. Set optional property values.

  5. Add the UserDefinedFunction object to the UserDefinedFunctions collection of a connected Database object.

After a user-defined function is created, you cannot reset the Name property. To change the name of a user-defined function, you must call the Remove method to drop and then re-create the object.

Note

The UserDefinedFunction object is compatible only with SQL Server 2000 and later.