UserDefinedFunction 类

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

继承层次结构

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.UserDefinedFunction

命名空间:  Microsoft.SqlServer.Management.Smo
程序集:  Microsoft.SqlServer.Smo(在 Microsoft.SqlServer.Smo.dll 中)

语法

声明
<StateChangeEventAttribute("RENAME", "FUNCTION")> _
<StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")> _
<StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")> _
<StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)> _
Public NotInheritable Class UserDefinedFunction _
    Inherits ScriptSchemaObjectBase _
    Implements ICreatable, IAlterable, IRenamable, IDroppable,  _
    IExtendedProperties, IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission,  _
    IObjectPermission
用法
Dim instance As UserDefinedFunction
[StateChangeEventAttribute("RENAME", "FUNCTION")]
[StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")]
[StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")]
[StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
public sealed class UserDefinedFunction : ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties, 
    IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission
[StateChangeEventAttribute(L"RENAME", L"FUNCTION")]
[StateChangeEventAttribute(L"CREATE_FUNCTION", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_FUNCTION", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_SCHEMA", L"FUNCTION")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
public ref class UserDefinedFunction sealed : public ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties, 
    IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission
[<SealedAttribute>]
[<StateChangeEventAttribute("RENAME", "FUNCTION")>]
[<StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")>]
[<StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")>]
[<StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
type UserDefinedFunction =  
    class 
        inherit ScriptSchemaObjectBase 
        interface ICreatable 
        interface IAlterable 
        interface IRenamable 
        interface IDroppable 
        interface IExtendedProperties 
        interface IScriptable 
        interface ITextObject 
        interface ISfcSupportsDesignMode 
        interface IColumnPermission 
        interface IObjectPermission 
    end
public final class UserDefinedFunction extends ScriptSchemaObjectBase implements ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties, IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission

UserDefinedFunction 类型公开以下成员。

构造函数

  名称 说明
公共方法 UserDefinedFunction() Initializes a new instance of the UserDefinedFunction class.
公共方法 UserDefinedFunction(Database, String) Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name.
公共方法 UserDefinedFunction(Database, String, String) Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name and schema.

页首

属性

  名称 说明
公共属性 AnsiNullsStatus Gets the Boolean property value that specifies whether ISO NULL handling is enabled in the user-defined function.
公共属性 AssemblyName Gets or sets the name of the assembly for the user-defined function.
公共属性 Checks Represents a collection of Check objects. Each Check object represents a check constraint defined on the user-defined function.
公共属性 ClassName Gets or sets the name of the class for the user-defined function.
公共属性 Columns Represents a collection of Column objects. Each Column object represents a column defined on the user-defined function.
公共属性 CreateDate Gets the date and time when the user-defined function was created.
公共属性 DataType Gets or sets the return type for scalar functions.
公共属性 DateLastModified Gets the date and time when the user-defined function was last modified.
公共属性 Events Gets the events associated with the user-defined function.
公共属性 ExecutionContext Gets or sets the execution context for the user-defined function.
公共属性 ExecutionContextPrincipal Gets or sets the execution context principal for the user-defined function.
公共属性 ExtendedProperties Gets the extended properties of the UserDefinedFunction object.
公共属性 FunctionType Gets or sets the user-defined function type.
公共属性 ID Gets the ID value that uniquely identifies the user-defined function.
公共属性 ImplementationType Gets or sets the implementation type of the user-defined function.
公共属性 Indexes Represents a collection of Index objects. Each Index object represents an index defined on the user-defined function.
公共属性 IsDeterministic Gets or sets the Boolean property value that specifies whether the user-defined function is deterministic.
公共属性 IsEncrypted Gets or sets the Boolean property value that specifies whether the user-defined function is encrypted.
公共属性 IsSchemaBound Gets or sets the Boolean property value that specifies whether the user-defined function is bound to a schema.
公共属性 IsSchemaOwned Gets a Boolean value that indicates whether the UserDefinedFunction object is owned by a schema.
公共属性 IsSystemObject Gets the Boolean property value that specifies whether the user-defined function is a system object.
公共属性 MethodName Gets the method name for the user-defined function.
公共属性 Name Gets or sets a String value that specifies the name of the user defined function. (覆盖 ScriptSchemaObjectBase.Name。)
公共属性 OrderColumns Gets the OrderColumnsCollection that is associated with this user-defined function.
公共属性 Owner Gets the name of the owner of the UserDefinedFunction object.
公共属性 Parameters Represents a collection of Parameter objects. Each Parameter object represents a parameter defined for the user-defined function.
公共属性 Parent Gets or sets the Database object that is the parent of the UserDefinedFunction object.
公共属性 Properties Gets a collection of Property objects that represent the object properties. (从 SqlSmoObject 继承。)
公共属性 QuotedIdentifierStatus 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.
公共属性 ReturnsNullOnNullInput Gets or sets the Boolean property that specifies whether to call the function if at least one of the function arguments is null.
公共属性 Schema Gets or sets a String value that specifies the name of the schema that contains the user defined function. (覆盖 ScriptSchemaObjectBase.Schema。)
公共属性 State Gets the state of the referenced object. (从 SmoObjectBase 继承。)
公共属性 TableVariableName Gets or sets the table variable name.
公共属性 TextBody Gets or sets the Transact-SQL string that defines the user-defined function.
公共属性 TextHeader Gets or sets the header part of the Transact-SQL string that defines the user-defined function.
公共属性 TextMode Gets or sets the Boolean property that specifies whether the text header is editable as text.
公共属性 Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (从 SqlSmoObject 继承。)
公共属性 UserData Gets or sets user-defined data associated with the referenced object. (从 SmoObjectBase 继承。)

页首

方法

  名称 说明
公共方法 Alter Updates any UserDefinedFunction object property changes on the instance of SQL Server. 
公共方法 ChangeSchema Changes the schema for the user-defined function.
公共方法 Create Creates a user-defined function on the instance of SQL Server as defined by the UserDefinedFunction object.
公共方法 Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the user-defined function.
公共方法 Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the user-defined function.
公共方法 Deny(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.
公共方法 Deny(ObjectPermissionSet, String, array<String[]) Denies the specified set of permissions to the grantee on the specified columns on the user-defined function.
公共方法 Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified permission for the specified grantees on the user-defined function.
公共方法 Deny(ObjectPermissionSet, array<String[], array<String[]) Denies the specified set of permissions for the grantees on the specified columns on the user-defined function.
公共方法 Deny(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.
公共方法 Deny(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.
公共方法 Discover Discovers a list of type Object. (从 SqlSmoObject 继承。)
公共方法 Drop Removes the user-defined function from the instance of SQL Server.
公共方法 EnumColumnPermissions() Enumerates a list of column permissions for the user-defined function.
公共方法 EnumColumnPermissions(String) Enumerates a list of column permissions for a specified grantee on the user-defined function.
公共方法 EnumColumnPermissions(ObjectPermissionSet) Enumerates a list of column permissions for a specified permission on the user-defined function.
公共方法 EnumColumnPermissions(String, ObjectPermissionSet) Enumerates a list of column permissions for a specified grantee and a specified permission on the user-defined function.
公共方法 EnumObjectPermissions() Enumerates a list of object permissions for the user-defined function.
公共方法 EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the user-defined function.
公共方法 EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the user-defined function.
公共方法 EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined function.
公共方法 Equals (从 Object 继承。)
受保护方法 FormatSqlVariant Formats an object as SqlVariant type. (从 SqlSmoObject 继承。)
受保护方法 GetContextDB Gets the context database that is associated with this object. (从 SqlSmoObject 继承。)
受保护方法 GetDBName Gets the database name that is associated with the object. (从 SqlSmoObject 继承。)
公共方法 GetHashCode (从 Object 继承。)
受保护方法 GetPropValue Gets a property value of the SqlSmoObject object. (从 SqlSmoObject 继承。)
受保护方法 GetPropValueOptional Gets a property value of the SqlSmoObject object. (从 SqlSmoObject 继承。)
受保护方法 GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (从 SqlSmoObject 继承。)
受保护方法 GetServerObject Gets the server of the SqlSmoObject object. (从 SqlSmoObject 继承。)
公共方法 GetType (从 Object 继承。)
公共方法 Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the user-defined function.
公共方法 Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the user-defined function.
公共方法 Grant(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.
公共方法 Grant(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.
公共方法 Grant(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.
公共方法 Grant(ObjectPermissionSet, array<String[], array<String[]) Grants the specified set of permissions to the grantees to the specified columns on the user-defined function.
公共方法 Grant(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.
公共方法 Grant(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.
公共方法 Grant(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.
公共方法 Grant(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.
公共方法 Grant(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.
公共方法 Grant(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.
公共方法 Initialize() Initializes the object and forces the properties be loaded. (从 SqlSmoObject 继承。)
公共方法 Initialize(Boolean) Initializes the object and forces the properties be loaded. (从 SqlSmoObject 继承。)
受保护方法 IsObjectInitialized Verifies whether the object has been initialized. (从 SqlSmoObject 继承。)
受保护方法 IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (从 SqlSmoObject 继承。)
公共方法 Refresh Refreshes the UserDefinedFunction object properties. (覆盖 ScriptNameObjectBase.Refresh()。)
公共方法 Rename Renames the user-defined function.
公共方法 Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the user-defined function.
公共方法 Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the user-defined function.
公共方法 Revoke(ObjectPermissionSet, String, array<String[]) Revokes a previously granted set of permissions from a grantee on the specified columns on the user-defined function.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Revoke(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.
公共方法 Script() Generates a Transact-SQL script that can be used to re-create the user-defined function.
公共方法 Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the user-defined function as specified by the script options.
公共方法 ScriptHeader Returns the text header with the option to modify the text.
受保护方法 SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (从 SqlSmoObject 继承。)
公共方法 ToString Returns a String that represents the referenced object. (从 SqlSmoObject 继承。)
公共方法 Validate Validates the state of an object. (从 SmoObjectBase 继承。)

页首

事件

  名称 说明
公共事件 PropertyChanged Represents the event that occurs when a property is changed. (从 SqlSmoObject 继承。)
公共事件 PropertyMetadataChanged Represents the event that occurs when property metadata changes. (从 SqlSmoObject 继承。)

页首

显式接口实现

  名称 说明
显式接口实现私有方法 IAlienObject.Discover Discovers any dependencies. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetDomainRoot Returns the root of the domain. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetParent Gets the parent of this object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetPropertyType Gets the type of the specified property. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetPropertyValue Gets the value of the specified property. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.SetPropertyValue Sets the property value. (从 SqlSmoObject 继承。)
显式接口实现私有方法 ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (从 SqlSmoObject 继承。)
显式接口实现私有属性 ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that specifies whether the user defined function supports design mode.

页首

注释

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

此类型的任何公共静态(Microsoft Visual Basic 中的 Shared)成员在多线程操作中是安全的。但不保证所有实例成员都是线程安全的。

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Smo 命名空间

其他资源

CREATE FUNCTION (Transact-SQL)