UserDefinedFunction 類別
UserDefinedFunction 物件表示 SQL Server 使用者定義的函數。
繼承階層
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("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
'用途
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
UserDefinedFunction 型別公開下列成員。
建構函式
| 名稱 | 說明 | |
|---|---|---|
.gif "公用方法") |
UserDefinedFunction() () () () | 初始化 UserDefinedFunction 類別的新執行個體。 |
|
UserDefinedFunction(Database, String) | 初始化位於指定的資料庫上且擁有指定名稱之 UserDefinedFunction 類別的新執行個體。 |
|
UserDefinedFunction(Database, String, String) | 初始化位於指定的資料庫上且擁有指定名稱和結構描述之 UserDefinedFunction 類別的新執行個體。 |
上層
屬性
| 名稱 | 說明 | |
|---|---|---|
.gif "公用屬性") |
AnsiNullsStatus | 取得 Boolean 屬性值，這個值會指定是否啟用使用者定義函數中的 ISO NULL 處理。 |
|
AssemblyName | 取得或設定使用者定義函數之組件的名稱。 |
|
Checks | 表示 Check 物件的集合。每個 Check 物件代表使用者定義函數上所定義的檢查條件約束。 |
|
ClassName | 取得或設定使用者定義函數之類別的名稱。 |
|
Columns | 表示 Column 物件的集合。每個 Column 物件代表使用者定義函數上所定義的資料行。 |
|
CreateDate | 取得建立使用者定義函數的日期和時間。 |
|
DataType | 取得或設定純量函式的傳回型別。 |
|
DateLastModified | 取得上次修改使用者定義函數的日期和時間。 |
|
Events | 取得與使用者定義函數相關聯的事件。 |
.gif "受保護的屬性") |
ExecuteForScalar | 取得或設定 Boolean 屬性值，指定物件是否設定為執行純量選項。 (繼承自 SqlSmoObject。) |
|
ExecutionContext | 取得或設定使用者定義函數的執行內容。 |
|
ExecutionContextPrincipal | 取得或設定使用者定義函數的執行內容主體。 |
|
ExtendedProperties | 取得 UserDefinedFunction 物件的擴充屬性。 |
|
FunctionType | 取得或設定使用者定義的函數類型。 |
|
ID | 取得可唯一識別使用者定義函數的識別碼值。 |
|
ImplementationType | 取得或設定使用者定義函數的實作類型。 |
|
Indexes | 表示 Index 物件的集合。每個 Index 物件代表使用者定義函數上所定義的索引。 |
|
IsDeterministic | 取得或設定 Boolean 屬性值，這個值會指定使用者定義函數是否具決定性。 |
|
IsEncrypted | 取得或設定 Boolean 屬性值，指定使用者定義函數是否為加密。 |
|
IsSchemaBound | 取得或設定 Boolean 屬性值，這個值會指定使用者定義函數是否繫結至結構描述。 |
|
IsSchemaOwned | 取得 Boolean 值，這個值會指出 UserDefinedFunction 物件是否為結構描述所擁有。 |
|
IsSystemObject | 取得 Boolean 屬性值，指定使用者定義函數是否為系統物件。 |
|
IsTouched | 取得 Boolean 屬性值，指定物件屬性是否已更新但尚未保存在伺服器上。 (繼承自 SqlSmoObject。) |
|
MethodName | 取得使用者定義函數的方法名稱。 |
|
Name | 取得或設定指定使用者定義函數名稱的 String 值。 (覆寫 ScriptSchemaObjectBase. . :: . .Name。) |
|
ObjectInSpace | 取得 Boolean 屬性值，指定物件是否存在於隔離中，或是直接或間接連接至 SQL Server 執行個體。 (繼承自 SqlSmoObject。) |
|
OrderColumns | 取得與這個使用者定義函數相關聯的 OrderColumnsCollection。 |
|
Owner | 取得 UserDefinedFunction 物件擁有者的名稱。 |
|
Parameters | 表示 Parameter 物件的集合。每個 Parameter 物件都表示針對使用者定義函數所定義的參數。 |
|
Parent | 取得或設定 Database 物件，該物件為 UserDefinedFunction 物件的父系。 |
|
Properties | 取得代表物件屬性的 Property 物件集合。 (繼承自 SqlSmoObject。) |
|
QuotedIdentifierStatus | 取得或設定 Boolean 屬性值，這個值會指定以雙引號分隔的識別碼是否為 Transact-SQL 保留的關鍵字，或包含使用者定義函數中 Transact-SQL 語法規則通常不允許的字元。 |
|
ReturnsNullOnNullInput | 取得或設定 Boolean 屬性，這個屬性會指定至少有一個函數引數為 Null 時是否呼叫函數。 |
|
ScalarResult | 取得受參考物件的純量結果。 (繼承自 SqlSmoObject。) |
|
Schema | 取得或設定 String 值，這個值指定包含使用者定義函數的結構描述名稱。 (覆寫 ScriptSchemaObjectBase. . :: . .Schema。) |
|
State | Gets the state of the referenced object. (繼承自 SmoObjectBase。) |
|
TableVariableName | 取得或設定資料表變數名稱。 |
|
TextBody | 取得或設定 Transact-SQL 字串，該字串會定義使用者定義函數。 |
|
TextHeader | 取得或設定 Transact-SQL 字串的標頭部分，該字串會定義使用者定義的函數。 |
|
TextMode | 取得或設定 Boolean 屬性，指定文字標頭是否可做為文字編輯。 |
|
Urn | 取得可唯一識別物件的統一資源名稱 (URN) 位址值。 (繼承自 SqlSmoObject。) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (繼承自 SmoObjectBase。) |
上層
方法
.gif "受保護的方法")
上層
事件
| 名稱 | 說明 | |
|---|---|---|
.gif "公用事件") |
PropertyChanged | 代表屬性變更時所發生的事件。 (繼承自 SqlSmoObject。) |
|
PropertyMetadataChanged | 代表屬性中繼資料變更時所發生的事件。 (繼承自 SqlSmoObject。) |
上層
欄位
| 名稱 | 說明 | |
|---|---|---|
.gif "受保護的欄位") |
m_ExtendedProperties | 代表屬性，此屬性定義為擴充 SqlSmoObject 所提供的屬性。 (繼承自 SqlSmoObject。) |
|
singletonParent | 代表單一父代。 (繼承自 SqlSmoObject。) |
上層
明確 繼承 實作
| 名稱 | 說明 | |
|---|---|---|
.gif "明確介面實作") .gif "私用方法") |
IAlienObject. . :: . .Discover | 探索任何相依性。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetDomainRoot | 傳回網域的根目錄。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetParent | 取得此物件的父系。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetPropertyType | 取得指定的屬性類型。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetPropertyValue | 取得指定的屬性值。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetUrn | 取得物件的統一資源名稱。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .Resolve | 取得執行個體，其中包含物件統一資源名稱之物件的相關資訊。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .SetObjectState | 將物件狀態設定為指定的 SfcObjectState 值。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .SetPropertyValue | 設定屬性值。 (繼承自 SqlSmoObject。) |
|
ISfcPropertyProvider. . :: . .GetPropertySet | 取得此物件屬性集的介面參考。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
.gif "私用屬性") |
ISfcSupportsDesignMode. . :: . .IsDesignMode | 取得 Boolean 值，這個值指定使用者定義函數是否支援設計模式。 |
上層
備註
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 為共用) 成員具備多執行緒作業安全。不保證所有執行個體成員都是安全執行緒。
執行緒安全性
這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。