UserDefinedFunctionCollection Class

The UserDefinedFunctionCollection class represents a collection of UserDefinedFunction objects that represent all the user-defined functions that are defined on a table.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.SchemaCollectionBase
          Microsoft.SqlServer.Management.Smo.UserDefinedFunctionCollection

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class UserDefinedFunctionCollection _
    Inherits SchemaCollectionBase
'Usage
Dim instance As UserDefinedFunctionCollection
public sealed class UserDefinedFunctionCollection : SchemaCollectionBase
public ref class UserDefinedFunctionCollection sealed : public SchemaCollectionBase
[<SealedAttribute>]
type UserDefinedFunctionCollection =  
    class 
        inherit SchemaCollectionBase 
    end
public final class UserDefinedFunctionCollection extends SchemaCollectionBase

The UserDefinedFunctionCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public property IsSynchronized Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public property Item[Int32] Gets a UserDefinedFunction object in the collection by index number.
Public property Item[String] Gets a UserDefinedFunction object in the collection by name.
Public property Item[String, String] Gets a UserDefinedFunction object in the collection by name and schema.
Public property Parent Gets the Database object that is the parent of the UserDefinedFunction object.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

  Name Description
Public method Add Adds a user-defined function to the collection.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Public method Contains(String) Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from SchemaCollectionBase.)
Public method Contains(String, String) Validates whether the parameter collection contains a member with a name equal to the specified string and with the specified schema. (Inherited from SchemaCollectionBase.)
Public method CopyTo Copies the collection objects to a one-dimensional array starting at the specidied index value.
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method ItemById Extracts a member from the UserDefinedFunctionCollection collection by using a system-defined, unique identifier.
Public method Refresh() Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public method Refresh(Boolean) Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Protected field initialized This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

Remarks

A UserDefinedFunctionCollection object can be used to gain access to a set of user-defined functions. You can use the Item property to return a specific UserDefinedFunction object.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Using Collections

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace