TechNet
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)


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

NameDescription
System_CAPS_pubmethodUserDefinedFunction()

Initializes a new instance of the UserDefinedFunction class.

System_CAPS_pubmethodUserDefinedFunction(Database^, String^)

Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name.

System_CAPS_pubmethodUserDefinedFunction(Database^, String^, String^)

Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name and schema.

NameDescription
System_CAPS_pubpropertyAnsiNullsStatus

Gets the Boolean property value that specifies whether ISO NULL handling is enabled in the user-defined function.

System_CAPS_pubpropertyAssemblyName

Gets or sets the name of the assembly for the user-defined function.

System_CAPS_pubpropertyChecks

Represents a collection of Check objects. Each Check object represents a check constraint defined on the user-defined function.

System_CAPS_pubpropertyClassName

Gets or sets the name of the class for the user-defined function.

System_CAPS_pubpropertyColumns

Represents a collection of Column objects. Each Column object represents a column defined on the user-defined function.

System_CAPS_pubpropertyCreateDate

Gets the date and time when the user-defined function was created.

System_CAPS_pubpropertyDataType

Gets or sets the return type for scalar functions.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the user-defined function was last modified.

System_CAPS_pubpropertyEvents

Gets the events associated with the user-defined function.

System_CAPS_pubpropertyExecutionContext

Gets or sets the execution context for the user-defined function.

System_CAPS_pubpropertyExecutionContextPrincipal

Gets or sets the execution context principal for the user-defined function.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExtendedProperties

Gets the extended properties of the UserDefinedFunction object.

System_CAPS_pubpropertyFunctionType

Gets or sets the user-defined function type.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the user-defined function.

System_CAPS_pubpropertyImplementationType

Gets or sets the implementation type of the user-defined function.

System_CAPS_pubpropertyIndexes

Represents a collection of Index objects. Each Index object represents an index defined on the user-defined function.

System_CAPS_pubpropertyIsDeterministic

Gets or sets the Boolean property value that specifies whether the user-defined function is deterministic.

System_CAPS_pubpropertyIsEncrypted

Gets or sets the Boolean property value that specifies whether the user-defined function is encrypted.

System_CAPS_pubpropertyIsNativelyCompiled

System_CAPS_pubpropertyIsSchemaBound

Gets or sets the Boolean property value that specifies whether the user-defined function is bound to a schema.

System_CAPS_pubpropertyIsSchemaOwned

Gets a Boolean value that indicates whether the UserDefinedFunction object is owned by a schema.

System_CAPS_pubpropertyIsSystemObject

Gets the Boolean property value that specifies whether the user-defined function is a system object.

System_CAPS_pubpropertyMethodName

Gets the method name for the user-defined function.

System_CAPS_pubpropertyName

Gets or sets a String value that specifies the name of the user defined function.(Overrides ScriptSchemaObjectBase::Name.)

System_CAPS_pubpropertyOrderColumns

Gets the T:Microsoft.SqlServer.Management.Smo.OrderColumnsCollection that is associated with this user-defined function.

System_CAPS_pubpropertyOwner

Gets the name of the owner of the UserDefinedFunction object.

System_CAPS_pubpropertyParameters

Represents a collection of Parameter objects. Each Parameter object represents a parameter defined for the user-defined function.

System_CAPS_pubpropertyParent

Gets or sets the Database object that is the parent of the UserDefinedFunction object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyQuotedIdentifierStatus

Gets 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.

System_CAPS_pubpropertyReturnsNullOnNullInput

Gets or sets the Boolean property that specifies whether to call the function if at least one of the function arguments is null.

System_CAPS_pubpropertySchema

Gets or sets a String value that specifies the name of the schema that contains the user defined function.(Overrides ScriptSchemaObjectBase::Schema.)

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyTableVariableName

Gets or sets the table variable name.

System_CAPS_pubpropertyTextBody

Gets or sets the Transact-SQL string that defines the user-defined function.

System_CAPS_pubpropertyTextHeader

Gets or sets the header part of the Transact-SQL string that defines the user-defined function.

System_CAPS_pubpropertyTextMode

Gets or sets the Boolean property that specifies whether the text header is editable as text.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any UserDefinedFunction object property changes on the instance of SQL Server. 

System_CAPS_pubmethodChangeSchema(String^)

Changes the schema for the user-defined function.

System_CAPS_pubmethodCreate()

Creates a user-defined function on the instance of SQL Server as defined by the UserDefinedFunction object.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, String^)

Denies the specified set of permissions for the specified grantee on the user-defined function.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, String^, array<String^>^)

Denies the specified set of permissions to the grantee on the specified columns on the user-defined function.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, array<String^>^)

Denies the specified set of permissions for the specified grantees on the user-defined function.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, array<String^>^, Boolean)

Denies the specified permission for the specified grantees on the user-defined function.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, array<String^>^, array<String^>^)

Denies the specified set of permissions for the grantees on the specified columns on the user-defined function.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the user-defined function from the instance of SQL Server.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumColumnPermissions()

Enumerates a list of column permissions for the user-defined function.

System_CAPS_pubmethodEnumColumnPermissions(ObjectPermissionSet^)

Enumerates a list of column permissions for a specified permission on the user-defined function.

System_CAPS_pubmethodEnumColumnPermissions(String^)

Enumerates a list of column permissions for a specified grantee on the user-defined function.

System_CAPS_pubmethodEnumColumnPermissions(String^, ObjectPermissionSet^)

Enumerates a list of column permissions for a specified grantee and a specified permission on the user-defined function.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the user-defined function.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet^)

Enumerates a list of object permissions for a specified permission on the user-defined function.

System_CAPS_pubmethodEnumObjectPermissions(String^)

Enumerates a list of object permissions for a specified grantee on the user-defined function.

System_CAPS_pubmethodEnumObjectPermissions(String^, ObjectPermissionSet^)

Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined function.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object^)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet^, String^)

Grants the specified set of permissions to the specified grantee on the user-defined function.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, array<String^>^)

Grants the specified set of permissions to the specified grantees on the user-defined function.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, array<String^>^, array<String^>^)

Grants the specified set of permissions to the grantees to the specified columns on the user-defined function.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String^)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the UserDefinedFunction object properties.(Overrides ScriptNameObjectBase::Refresh().)

System_CAPS_pubmethodRename(String^)

Renames the user-defined function.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, String^)

Revokes a previously granted set of permissions from a grantee on the user-defined function.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, String^, array<String^>^)

Revokes a previously granted set of permissions from a grantee on the specified columns on the user-defined function.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, array<String^>^)

Revokes a previously granted set of permissions from a list of grantees on the user-defined function.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the user-defined function.

System_CAPS_pubmethodScript(ScriptingOptions^)

Generates a Transact-SQL script that can be used to re-create the user-defined function as specified by the script options.

System_CAPS_pubmethodScriptHeader(Boolean)

Returns the text header with the option to modify the text.

System_CAPS_protmethodSetParentImpl(SqlSmoObject^)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String^, array<Object^>^)

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyType(String^)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyValue(String^, Type^)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetUrn()

Gets 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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Resolve(String^)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetPropertyValue(String^, Type^, Object^)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider::GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode::IsDesignMode

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.

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.

Return to top
Show:
© 2016 Microsoft