Export (0) Print
Expand All

UserDefinedFunction Class

The UserDefinedFunction object represents a SQL Server user-defined function.

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

[StateChangeEventAttribute(L"RENAME", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_SCHEMA", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_FUNCTION", L"FUNCTION")]
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[StateChangeEventAttribute(L"CREATE_FUNCTION", L"FUNCTION")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class UserDefinedFunction sealed : public ScriptSchemaObjectBase, 
	ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable, IAlterable, 
	IRenamable, IDroppable, IExtendedProperties, IScriptable, ITextObject

The UserDefinedFunction type exposes the following members.

  NameDescription
Public methodUserDefinedFunction()Initializes a new instance of the UserDefinedFunction class.
Public methodUserDefinedFunction(Database, String)Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name.
Public methodUserDefinedFunction(Database, String, String)Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name and schema.
Top

  NameDescription
Public propertyAnsiNullsStatusGets the Boolean property value that specifies whether ISO NULL handling is enabled in the user-defined function.
Public propertyAssemblyNameGets or sets the name of the assembly for the user-defined function.
Public propertyChecksRepresents a collection of Check objects. Each Check object represents a check constraint defined on the user-defined function.
Public propertyClassNameGets or sets the name of the class for the user-defined function.
Public propertyColumnsRepresents a collection of Column objects. Each Column object represents a column defined on the user-defined function.
Public propertyCreateDateGets the date and time when the user-defined function was created.
Public propertyDataTypeGets or sets the return type for scalar functions.
Public propertyDateLastModifiedGets the date and time when the user-defined function was last modified.
Public propertyEventsGets the events associated with the user-defined function.
Public propertyExecutionContextGets or sets the execution context for the user-defined function.
Public propertyExecutionContextPrincipalGets or sets the execution context principal for the user-defined function.
Public propertyExtendedPropertiesGets the extended properties of the UserDefinedFunction object.
Public propertyFunctionTypeGets or sets the user-defined function type.
Public propertyIDGets the ID value that uniquely identifies the user-defined function.
Public propertyImplementationTypeGets or sets the implementation type of the user-defined function.
Public propertyIndexesRepresents a collection of Index objects. Each Index object represents an index defined on the user-defined function.
Public propertyIsDeterministicGets or sets the Boolean property value that specifies whether the user-defined function is deterministic.
Public propertyIsEncryptedGets or sets the Boolean property value that specifies whether the user-defined function is encrypted.
Public propertyIsSchemaBoundGets or sets the Boolean property value that specifies whether the user-defined function is bound to a schema.
Public propertyIsSchemaOwnedGets a Boolean value that indicates whether the UserDefinedFunction object is owned by a schema.
Public propertyIsSystemObjectGets the Boolean property value that specifies whether the user-defined function is a system object.
Public propertyMethodNameGets the method name for the user-defined function.
Public propertyNameGets or sets a String value that specifies the name of the user defined function. (Overrides ScriptSchemaObjectBase::Name.)
Public propertyOrderColumnsGets the OrderColumnsCollection that is associated with this user-defined function.
Public propertyOwnerGets the name of the owner of the UserDefinedFunction object.
Public propertyParametersRepresents a collection of Parameter objects. Each Parameter object represents a parameter defined for the user-defined function.
Public propertyParentGets or sets the Database object that is the parent of the UserDefinedFunction object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyQuotedIdentifierStatusGets or sets a Boolean property value that specifies whether identifiers delimited by double quotation marks are Transact-SQL reserved keywords or contain characters not usually allowed by the Transact-SQL syntax rules in the user-defined function.
Public propertyReturnsNullOnNullInputGets or sets the Boolean property that specifies whether to call the function if at least one of the function arguments is null.
Public propertySchemaGets or sets a String value that specifies the name of the schema that contains the user defined function. (Overrides ScriptSchemaObjectBase::Schema.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyTableVariableNameGets or sets the table variable name.
Public propertyTextBodyGets or sets the Transact-SQL string that defines the user-defined function.
Public propertyTextHeaderGets or sets the header part of the Transact-SQL string that defines the user-defined function.
Public propertyTextModeGets or sets the Boolean property that specifies whether the text header is editable as text.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any UserDefinedFunction object property changes on the instance of SQL Server. 
Public methodChangeSchemaChanges the schema for the user-defined function.
Public methodCreateCreates a user-defined function on the instance of SQL Server as defined by the UserDefinedFunction object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the user-defined function.
Public methodDeny(ObjectPermissionSet, array<String>)Denies the specified set of permissions for the specified grantees on the user-defined function.
Public methodDeny(ObjectPermissionSet, String, Boolean)Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the user-defined function.
Public methodDeny(ObjectPermissionSet, String, array<String>)Denies the specified set of permissions to the grantee on the specified columns on the user-defined function.
Public methodDeny(ObjectPermissionSet, array<String>, Boolean)Denies the specified permission for the specified grantees on the user-defined function.
Public methodDeny(ObjectPermissionSet, array<String>, array<String>)Denies the specified set of permissions for the grantees on the specified columns on the user-defined function.
Public methodDeny(ObjectPermissionSet, String, array<String>, Boolean)Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the specified columns on the user-defined function.
Public methodDeny(ObjectPermissionSet, array<String>, array<String>, Boolean)Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the specified columns on the user-defined function.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the user-defined function from the instance of SQL Server.
Public methodEnumColumnPermissions()Enumerates a list of column permissions for the user-defined function.
Public methodEnumColumnPermissions(String)Enumerates a list of column permissions for a specified grantee on the user-defined function.
Public methodEnumColumnPermissions(ObjectPermissionSet)Enumerates a list of column permissions for a specified permission on the user-defined function.
Public methodEnumColumnPermissions(String, ObjectPermissionSet)Enumerates a list of column permissions for a specified grantee and a specified permission on the user-defined function.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the user-defined function.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the user-defined function.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the user-defined function.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined function.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the user-defined function.
Public methodGrant(ObjectPermissionSet, array<String>)Grants the specified set of permissions to the specified grantees on the user-defined function.
Public methodGrant(ObjectPermissionSet, String, Boolean)Grants access to the specified permission and the ability to grant access to other uses for the specified grantee on the user-defined function.
Public methodGrant(ObjectPermissionSet, String, array<String>)Grants access to the specified permission on the specified columns for the specified grantee on the specified columns on the user-defined function.
Public methodGrant(ObjectPermissionSet, array<String>, Boolean)Grants access to the specified permission and the ability to grant access to other uses for the specified grantees on the user-defined function.
Public methodGrant(ObjectPermissionSet, array<String>, array<String>)Grants the specified set of permissions to the grantees to the specified columns on the user-defined function.
Public methodGrant(ObjectPermissionSet, String, Boolean, String)Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the user-defined function under an assumed role.
Public methodGrant(ObjectPermissionSet, String, array<String>, Boolean)Grants the specified permission to the grantee and the ability to grant the specified set of permissions to other users on the specified columns on the user-defined function.
Public methodGrant(ObjectPermissionSet, array<String>, Boolean, String)Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the user-defined function under an assumed role.
Public methodGrant(ObjectPermissionSet, array<String>, array<String>, Boolean)Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the specified columns on the user-defined function.
Public methodGrant(ObjectPermissionSet, String, array<String>, Boolean, String)Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the specified columns on the user-defined function under an assumed role.
Public methodGrant(ObjectPermissionSet, array<String>, array<String>, Boolean, String)Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the specified columns on the user-defined function under an assumed role.
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the UserDefinedFunction object properties. (Overrides ScriptNameObjectBase::Refresh().)
Public methodRenameRenames the user-defined function.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the user-defined function.
Public methodRevoke(ObjectPermissionSet, array<String>)Revokes a previously granted set of permissions from a list of grantees on the user-defined function.
Public methodRevoke(ObjectPermissionSet, String, array<String>)Revokes a previously granted set of permissions from a grantee on the specified columns on the user-defined function.
Public methodRevoke(ObjectPermissionSet, array<String>, array<String>)Revokes a previously granted set of permissions from a list of grantees on the specified columns on the user-defined function.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean)Revokes a previously granted set of permissions from a grantee on the user-defined function and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users.
Public methodRevoke(ObjectPermissionSet, array<String>, Boolean, Boolean)Revokes a previously granted set of permissions from grantees from the user-defined function and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean, String)Revokes a previously granted set of permissions from a grantee on the user-defined function and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, String, array<String>, Boolean, Boolean)Revokes a previously granted set of permissions from grantees on the specified columns on the user-defined function and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, array<String>, Boolean, Boolean, String)Revokes a previously granted set of permissions from grantees on the user-defined function and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, array<String>, array<String>, Boolean, Boolean)Revokes a previously granted set of permissions from grantees on the specified columns on the user-defined function and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users.
Public methodRevoke(ObjectPermissionSet, String, array<String>, Boolean, Boolean, String)Revokes a previously granted set of permissions from a grantee on the specified columns on the user-defined function and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodRevoke(ObjectPermissionSet, array<String>, array<String>, Boolean, Boolean, String)Revokes a previously granted set of permissions from grantees on the specified columns on the user-defined function and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the user-defined function.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the user-defined function as specified by the script options.
Public methodScriptHeaderReturns the text header with the option to modify the text.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject::DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetParentGets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetUrnGets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider::GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode::IsDesignModeGets a Boolean value that specifies whether the user defined function supports design mode.
Top

The UserDefinedFunction object provides functionality that allows users to programmatically manage functions.

To get UserDefinedFunction object properties, users can be a member of the public fixed server role.

To set UserDefinedFunction object properties, users must have ALTER permission on the user-defined function.

To create a user-defined function, users must have CREATE FUNCTION permission on the database and ALTER permission on the specified schema.

To drop a user-defined function, users must have CONTROL permission on the user-defined function and ALTER permission on the specified schema.

To grant, deny, or revoke permissions on the user-defined function to other users, users must have CONTROL permission on the user-defined function.

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft