Dela via


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)

Syntax

'Declaration
<StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")> _
<StateChangeEventAttribute("RENAME", "FUNCTION")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")> _
<StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)> _
<StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")> _
Public NotInheritable Class UserDefinedFunction _
    Inherits ScriptSchemaObjectBase _
    Implements ICreatable, IAlterable, IRenamable, IDroppable,  _
    IExtendedProperties, IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission,  _
    IObjectPermission
'Usage
Dim instance As UserDefinedFunction
[StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")]
[StateChangeEventAttribute("RENAME", "FUNCTION")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")]
[StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
[StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")]
public sealed class UserDefinedFunction : ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties, 
    IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission
[StateChangeEventAttribute(L"CREATE_FUNCTION", L"FUNCTION")]
[StateChangeEventAttribute(L"RENAME", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_FUNCTION", L"FUNCTION")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[StateChangeEventAttribute(L"ALTER_SCHEMA", L"FUNCTION")]
public ref class UserDefinedFunction sealed : public ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties, 
    IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission
[<SealedAttribute>]
[<StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")>]
[<StateChangeEventAttribute("RENAME", "FUNCTION")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")>]
[<StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
[<StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")>]
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

The UserDefinedFunction type exposes the following members.

Constructors

  Name Description
Public method UserDefinedFunction() Initializes a new instance of the UserDefinedFunction class.
Public method UserDefinedFunction(Database, String) Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name.
Public method UserDefinedFunction(Database, String, String) Initializes a new instance of the UserDefinedFunction class on the specified database and with the specified name and schema.

Top

Properties

  Name Description
Public property AnsiNullsStatus Gets the Boolean property value that specifies whether ISO NULL handling is enabled in the user-defined function.
Public property AssemblyName Gets or sets the name of the assembly for the user-defined function.
Public property Checks Represents a collection of Check objects. Each Check object represents a check constraint defined on the user-defined function.
Public property ClassName Gets or sets the name of the class for the user-defined function.
Public property Columns Represents a collection of Column objects. Each Column object represents a column defined on the user-defined function.
Public property CreateDate Gets the date and time when the user-defined function was created.
Public property DataType Gets or sets the return type for scalar functions.
Public property DateLastModified Gets the date and time when the user-defined function was last modified.
Public property Events Gets the events associated with the user-defined function.
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public property ExecutionContext Gets or sets the execution context for the user-defined function.
Public property ExecutionContextPrincipal Gets or sets the execution context principal for the user-defined function.
Public property ExtendedProperties Gets the extended properties of the UserDefinedFunction object.
Public property FunctionType Gets or sets the user-defined function type.
Public property ID Gets the ID value that uniquely identifies the user-defined function.
Public property ImplementationType Gets or sets the implementation type of the user-defined function.
Public property Indexes Represents a collection of Index objects. Each Index object represents an index defined on the user-defined function.
Public property IsDeterministic Gets or sets the Boolean property value that specifies whether the user-defined function is deterministic.
Public property IsEncrypted Gets or sets the Boolean property value that specifies whether the user-defined function is encrypted.
Public property IsSchemaBound Gets or sets the Boolean property value that specifies whether the user-defined function is bound to a schema.
Public property IsSchemaOwned Gets a Boolean value that indicates whether the UserDefinedFunction object is owned by a schema.
Public property IsSystemObject Gets the Boolean property value that specifies whether the user-defined function is a system object.
Protected property IsTouched Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public property MethodName Gets the method name for the user-defined function.
Public property Name Gets or sets a String value that specifies the name of the user defined function. (Overrides ScriptSchemaObjectBase.Name.)
Protected property ObjectInSpace Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public property OrderColumns Gets the OrderColumnsCollection that is associated with this user-defined function.
Public property Owner Gets the name of the owner of the UserDefinedFunction object.
Public property Parameters Represents a collection of Parameter objects. Each Parameter object represents a parameter defined for the user-defined function.
Public property Parent Gets or sets the Database object that is the parent of the UserDefinedFunction object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property 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.
Public property ReturnsNullOnNullInput Gets or sets the Boolean property that specifies whether to call the function if at least one of the function arguments is null.
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public property Schema Gets or sets a String value that specifies the name of the schema that contains the user defined function. (Overrides ScriptSchemaObjectBase.Schema.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property TableVariableName Gets or sets the table variable name.
Public property TextBody Gets or sets the Transact-SQL string that defines the user-defined function.
Public property TextHeader Gets or sets the header part of the Transact-SQL string that defines the user-defined function.
Public property TextMode Gets or sets the Boolean property that specifies whether the text header is editable as text.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Protected method AddDatabaseContext(StringCollection) Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Protected method AddDatabaseContext(StringCollection, ScriptingOptions) Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.)
Public method Alter Updates any UserDefinedFunction object property changes on the instance of SQL Server. 
Protected method AlterImpl Activates the object altered event. (Inherited from SqlSmoObject.)
Protected method AlterImplFinish Method called when object altered event finishes. (Inherited from SqlSmoObject.)
Protected method AlterImplInit Method called when object-altered event is intialized. (Inherited from SqlSmoObject.)
Protected method AlterImplWorker Calls the Alter methods. (Inherited from SqlSmoObject.)
Protected method AppendCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithOption Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AutoGenerateName Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
Protected method BindDefaultImpl Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected method BindRuleImpl Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Public method ChangeSchema Changes the schema for the user-defined function.
Protected method CheckCollation Checks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.)
Protected method CheckObjectDirty Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method CheckObjectState(Boolean) Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
Protected method CheckObjectStateImpl Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method CheckTextCorectness Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
Protected method CheckTextModeSupport Checks mode of support. (Inherited from ScriptNameObjectBase.)
Protected method CheckVersion100 Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected method CheckVersion80 Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3 Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90 Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90 Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CleanObject Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
Public method Create Creates a user-defined function on the instance of SQL Server as defined by the UserDefinedFunction object.
Protected method CreateImpl Creates an object with scripting options. (Inherited from SqlSmoObject.)
Protected method CreateImplFinish Method called when the create event finishes. (Inherited from SqlSmoObject.)
Protected method CreateImplInit Method called when the create event initializes. (Inherited from SqlSmoObject.)
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the user-defined function.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the user-defined function.
Public method 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.
Public method Deny(ObjectPermissionSet, String, array<String[]) Denies the specified set of permissions to the grantee on the specified columns on the user-defined function.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified permission for the specified grantees on the user-defined function.
Public method Deny(ObjectPermissionSet, array<String[], array<String[]) Denies the specified set of permissions for the grantees on the specified columns on the user-defined function.
Public method 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.
Public method 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.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the user-defined function from the instance of SQL Server.
Protected method DropImpl Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method DropImplWorker Calls the drop methods. (Inherited from SqlSmoObject.)
Public method EnumColumnPermissions() Enumerates a list of column permissions for the user-defined function.
Public method EnumColumnPermissions(String) Enumerates a list of column permissions for a specified grantee on the user-defined function.
Public method EnumColumnPermissions(ObjectPermissionSet) Enumerates a list of column permissions for a specified permission on the user-defined function.
Public method EnumColumnPermissions(String, ObjectPermissionSet) Enumerates a list of column permissions for a specified grantee and a specified permission on the user-defined function.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the user-defined function.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the user-defined function.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the user-defined function.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined function.
Protected method EnumScriptImpl Enumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorker Calls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected method EnumScriptImplWorkerSOChanged Returns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.)
Public method Equals (Inherited from Object.)
Protected method ExecuteNonQuery Executes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.)
Protected method Finalize (Inherited from Object.)
Protected method ForceTextModeOnTextBody Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceFileStreamScript Generates a script to create data file. (Inherited from SqlSmoObject.)
Protected method GenerateDataSpaceScript Generates a script to allocate space in the data file. (Inherited from SqlSmoObject.)
Protected method GetBindDefaultScript Gets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.)
Protected method GetBindRuleScript Gets the script that specifies the binding rules. (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetBraketNameForText Gets the bracket name. (Inherited from ScriptNameObjectBase.)
Protected method GetDateTimeParameter Assigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetDateTimeParameterAsInt Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Protected method GetEnumParameter Assigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetFragOptionString Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Protected method GetGuidParameter Assigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetIsSystemNamed Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method GetIsTextDirty Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetRealValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetScriptIncludeExists Gets the script including the test for existence of type being scripted. (Inherited from ScriptNameObjectBase.)
Protected method GetScriptingOptionsForCreate Gets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerName Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetTextBody() Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextBody(Boolean) Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextForScript(ScriptingOptions, Boolean, array<String[]) Gets the text for scripting. (Inherited from ScriptNameObjectBase.)
Protected method GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean) Gets the text of script object. (Inherited from ScriptNameObjectBase.)
Protected method GetTextHeader Returns the text header. (Inherited from ScriptNameObjectBase.)
Protected method GetTextMode Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty(String) Gets the property as text. (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty(String, ScriptingOptions) Gets the property as text. (Inherited from ScriptNameObjectBase.)
Protected method GetTimeSpanParameterAsInt Assigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the user-defined function.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the user-defined function.
Public method 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.
Public method 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.
Public method 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.
Public method Grant(ObjectPermissionSet, array<String[], array<String[]) Grants the specified set of permissions to the grantees to the specified columns on the user-defined function.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Protected method ImplInitialize Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectDirty Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected method IsVersion80SP3 Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected method IsVersion90AndAbove Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected method MarkDropped Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method PostAlter Method activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected method PostCreate Method activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected method PostDrop Method activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the UserDefinedFunction object properties. (Overrides ScriptNameObjectBase.Refresh().)
Public method Rename Renames the user-defined function.
Protected method RenameImpl Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Protected method ResetDesignModeScriptingOptions Resets options as specified by the options parameter. (Inherited from ScriptSchemaObjectBase.)
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the user-defined function.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the user-defined function.
Public method Revoke(ObjectPermissionSet, String, array<String[]) Revokes a previously granted set of permissions from a grantee on the specified columns on the user-defined function.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method Script() Generates a Transact-SQL script that can be used to re-create the user-defined function.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the user-defined function as specified by the script options.
Protected method ScriptAlter Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected method ScriptAnsiQI Scripts the database object in ANSI text. (Inherited from ScriptNameObjectBase.)
Protected method ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method ScriptCreate Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected method ScriptDdl Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected method ScriptDrop Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Public method ScriptHeader Returns the text header with the option to modify the text.
Protected method ScriptImpl() Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImplWorker Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptInformativeHeaders Scripts the information headers. (Inherited from ScriptNameObjectBase.)
Protected method ScriptOwner Alters the script owner authorization. (Inherited from NamedSmoObject.)
Protected method ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method SetCollectionTextMode Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
Protected method SetIsSystemNamed Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected method SetSchemaOwned Sets the schema owned value. (Inherited from NamedSmoObject.)
Protected method SetTextBody Specifies the text body. (Inherited from ScriptNameObjectBase.)
Protected method SetTextHeader Specifies the text header. (Inherited from ScriptNameObjectBase.)
Protected method SetTextMode Specifies the text mode. (Inherited from ScriptNameObjectBase.)
Protected method StoreConstraintsFlags Stores contraints flags as specified by the options parameter. (Inherited from ScriptSchemaObjectBase.)
Protected method SwitchTextMode Switches the text mode. (Inherited from ScriptNameObjectBase.)
Protected method ThrowIfTextIsDirtyForAlter Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl Not implemented. (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Fields

  Name Description
Protected field m_ExtendedProperties Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected field singletonParent Represents the singleton parent. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.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.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that specifies whether the user defined function supports design mode.

Top

Remarks

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.

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.