Classe UserDefinedFunction

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

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.Smo
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
<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
'Utilisation
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

Le type UserDefinedFunction expose les membres suivants.

Constructeurs

	Nom	Description
	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.

Haut de la page

Propriétés

	Nom	Description
	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. (remplace 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. (hérité de 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. (remplace ScriptSchemaObjectBase.Schema.)
	State	Gets the state of the referenced object. (hérité de 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. (hérité de SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (hérité de SmoObjectBase.)

Haut de la page

Méthodes

	Nom	Description
	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. (hérité de 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	(hérité de Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (hérité de SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (hérité de SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (hérité de SqlSmoObject.)
	GetHashCode	(hérité de Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (hérité de SqlSmoObject.)
	GetType	(hérité de 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. (hérité de SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (hérité de SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (hérité de SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (hérité de SqlSmoObject.)
	Refresh	Refreshes the UserDefinedFunction object properties. (remplace 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. (hérité de SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (hérité de SqlSmoObject.)
	Validate	Validates the state of an object. (hérité de SmoObjectBase.)

Haut de la page

Événements

	Nom	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (hérité de SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (hérité de SqlSmoObject.)

Haut de la page

Implémentations d'interfaces explicites

	Nom	Description
	IAlienObject.Discover	Discovers any dependencies. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (hérité de SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (hérité de SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (hérité de SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (hérité de SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (hérité de SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (hérité de SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (hérité de SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that specifies whether the user defined function supports design mode.

Haut de la page

Notes

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

Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Smo

Autres ressources

CREATE FUNCTION (Transact-SQL)