UserDefinedFunction Members
The UserDefinedFunction object represents a Microsoft SQL Server user-defined function.
The following tables list the members exposed by the UserDefinedFunction type.
Public Constructors
| Name | Description | |
|---|---|---|
| UserDefinedFunction | Overloaded. Initializes a new instance of the UserDefinedFunction class. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "ms220586.protfield(en-US,SQL.90).gif") |
m_ExtendedProperties | (inherited from SqlSmoObject ) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms220586.pubproperty(en-US,SQL.90).gif") |
AnsiNullsStatus | Gets the Boolean property value that specifies whether SQL-92 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 an extended property 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 an extended property 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 extended property 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. |
|
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 the name of the object. (inherited from NamedSmoObject) |
|
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. (inherited from 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 the schema. (inherited from ScriptSchemaObjectBase) |
|
State | Gets the state of the referenced object. (inherited from 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. (inherited from SqlSmoObject) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase) |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms220586.protproperty(en-US,SQL.90).gif") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject) |
|
PresetProperties | Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject) |
|
ScalarResult | Gets the scalar result for the referenced object. (inherited from SqlSmoObject) |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms220586.pubmethod(en-US,SQL.90).gif") |
Alter | Updates any UserDefinedFunction object property changes on the instance of Microsoft SQL Server. |
|
ChangeSchema | Changes the schema for the user-defined function. |
|
Create | Creates a user-defined function on the instance of Microsoft SQL Server as defined by the UserDefinedFunction object. |
|
Deny | Overloaded. Denies the specified set of permissions for the specified grantees on the user-defined function. |
|
Drop | Removes the user-defined function from the instance of Microsoft SQL Server. |
|
EnumColumnPermissions | Overloaded. Enumerates a list of column permissions for the user-defined function. |
|
EnumObjectPermissions | Overloaded. Enumerates a list of object permissions for the user-defined function. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Grant | Overloaded. Grants the specified set of permissions to the specified grantees on the user-defined function. |
|
Initialize | Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject) |
.gif "ms220586.static(en-US,SQL.90).gif") |
ReferenceEquals | (inherited from Object ) |
|
Refresh | Overridden. Refreshes the UserDefinedFunction object properties. |
|
Rename | Renames the user-defined function. |
|
Revoke | Overloaded. Revokes a previously granted set of permissions from a grantee or grantees on the user-defined function. |
|
Script | Overloaded. Generates a Transact-SQL script that can be used to re-create the user-defined function. |
|
ScriptHeader | Returns the text header with the option to modify the text. |
|
ToString | Returns a String that represents the referenced object. (inherited from SqlSmoObject) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms220586.protmethod(en-US,SQL.90).gif") |
AlterImpl | (inherited from SqlSmoObject ) |
|
AlterImplFinish | (inherited from SqlSmoObject ) |
|
AlterImplInit | (inherited from SqlSmoObject ) |
|
AlterImplWorker | (inherited from SqlSmoObject ) |
|
AppendCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithCommaText | (inherited from ScriptNameObjectBase ) |
|
AppendWithOption | (inherited from ScriptNameObjectBase ) |
|
BindDefaultImpl | (inherited from SqlSmoObject ) |
|
BindRuleImpl | (inherited from SqlSmoObject ) |
|
CheckCollation | (inherited from SqlSmoObject ) |
|
CheckObjectState | Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject) |
|
CheckObjectStateImpl | (inherited from SqlSmoObject ) |
|
CheckTextCorectness | (inherited from ScriptNameObjectBase ) |
|
CheckTextModeSupport | (inherited from ScriptNameObjectBase ) |
|
CheckVersion80 | Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject) |
|
CheckVersion80SP3 | Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject) |
|
CheckVersion90 | Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject) |
|
CheckVersionBelow90 | (inherited from SqlSmoObject ) |
|
CleanObject | Cleans the referenced object. (inherited from ScriptNameObjectBase) |
|
CreateImpl | (inherited from SqlSmoObject ) |
|
CreateImplFinish | (inherited from SqlSmoObject ) |
|
CreateImplInit | (inherited from SqlSmoObject ) |
|
DropImpl | (inherited from SqlSmoObject ) |
|
DropImplWorker | (inherited from SqlSmoObject ) |
|
Finalize | (inherited from Object ) |
|
ForceTextModeOnTextBody | Enforces text mode on the text body. (inherited from ScriptNameObjectBase) |
|
FormatSqlVariant | (inherited from SqlSmoObject ) |
|
GenerateDataSpaceScript | (inherited from SqlSmoObject ) |
|
GetBindDefaultScript | (inherited from SqlSmoObject ) |
|
GetBindRuleScript | (inherited from SqlSmoObject ) |
|
GetBoolParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetBraketNameForText | (inherited from ScriptNameObjectBase ) |
|
GetDateTimeParameter | (inherited from SqlSmoObject ) |
|
GetDateTimeParameterAsInt | (inherited from SqlSmoObject ) |
|
GetDBName | Gets the database name associated with the object. (inherited from SqlSmoObject) |
|
GetEnumParameter | (inherited from SqlSmoObject ) |
|
GetFragOptionString | (inherited from SqlSmoObject ) |
|
GetGuidParameter | (inherited from SqlSmoObject ) |
|
GetIsTextDirty | Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase) |
|
GetParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetPropValue | (inherited from SqlSmoObject ) |
|
GetPropValueOptional | (inherited from SqlSmoObject ) |
|
GetPropValueOptionalAllowNull | (inherited from SqlSmoObject ) |
|
GetRealValue | (inherited from SqlSmoObject ) |
|
GetScriptIncludeExists | (inherited from ScriptNameObjectBase ) |
|
GetScriptingOptionsForCreate | (inherited from SqlSmoObject ) |
|
GetServerName | Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetSqlServerVersionName | Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetStringParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetTextBody | Overloaded. Returns the text body. (inherited from ScriptNameObjectBase) |
|
GetTextForScript | (inherited from ScriptNameObjectBase ) |
|
GetTextHeader | (inherited from ScriptNameObjectBase ) |
|
GetTextMode | Determines whether the script name is using text mode. (inherited from ScriptNameObjectBase) |
|
GetTextProperty | (inherited from ScriptNameObjectBase ) |
|
GetTimeSpanParameterAsInt | (inherited from SqlSmoObject ) |
|
GetUrnRecursive | Overloaded. (inherited from SqlSmoObject ) |
|
ImplInitialize | (inherited from SqlSmoObject ) |
|
IsCollectionDirty | (inherited from SqlSmoObject ) |
|
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. (inherited from ScriptNameObjectBase) |
|
IsObjectInitialized | Verifies whether the object has been initialized. (inherited from SqlSmoObject) |
|
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject) |
|
IsVersion80SP3 | (inherited from SqlSmoObject ) |
|
MarkDropped | (inherited from SqlSmoObject ) |
|
MarkForDropImpl | (inherited from SqlSmoObject ) |
|
MemberwiseClone | (inherited from Object ) |
|
PostAlter | (inherited from SqlSmoObject ) |
|
PostCreate | (inherited from SqlSmoObject ) |
|
PostDrop | (inherited from SqlSmoObject ) |
|
RenameImpl | (inherited from NamedSmoObject ) |
|
RenameImplWorker | (inherited from NamedSmoObject ) |
|
ScriptAlter | (inherited from SqlSmoObject ) |
|
ScriptAnsiQI | (inherited from ScriptNameObjectBase ) |
|
ScriptChangeOwner | (inherited from NamedSmoObject ) |
|
ScriptCreate | (inherited from SqlSmoObject ) |
|
ScriptDdl | (inherited from SqlSmoObject ) |
|
ScriptDrop | (inherited from SqlSmoObject ) |
|
ScriptImpl | Overloaded. (inherited from SqlSmoObject ) |
|
ScriptImplWorker | (inherited from SqlSmoObject ) |
|
ScriptInformativeHeaders | (inherited from ScriptNameObjectBase ) |
|
ScriptRename | (inherited from NamedSmoObject ) |
|
SetCollectionTextMode | (inherited from ScriptNameObjectBase ) |
|
SetParentImpl | (inherited from SqlSmoObject ) |
|
SetTextBody | (inherited from ScriptNameObjectBase ) |
|
SetTextHeader | (inherited from ScriptNameObjectBase ) |
|
SetTextMode | (inherited from ScriptNameObjectBase ) |
|
SwitchTextMode | (inherited from ScriptNameObjectBase ) |
|
ThrowIfTextIsDirtyForAlter | (inherited from ScriptNameObjectBase ) |
|
Trace | (inherited from SqlSmoObject ) |
|
UnbindDefaultImpl | (inherited from SqlSmoObject ) |
|
UnbindRuleImpl | (inherited from SqlSmoObject ) |
|
UpdateCollectionState2 | (inherited from SqlSmoObject ) |
Top
See Also
Reference
UserDefinedFunction Class
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
User-defined Functions (Database Engine)
CREATE FUNCTION (Transact-SQL)