PartitionFunctionParameter Class
The PartitionFunctionParameter object provides programmatic access to partition function parameters.
Inheritance Hierarchy
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.PartitionFunctionParameter
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public NotInheritable Class PartitionFunctionParameter _
Inherits ScriptNameObjectBase _
Implements ISfcSupportsDesignMode
'Usage
Dim instance As PartitionFunctionParameter
public sealed class PartitionFunctionParameter : ScriptNameObjectBase,
ISfcSupportsDesignMode
public ref class PartitionFunctionParameter sealed : public ScriptNameObjectBase,
ISfcSupportsDesignMode
[<SealedAttribute>]
type PartitionFunctionParameter =
class
inherit ScriptNameObjectBase
interface ISfcSupportsDesignMode
end
public final class PartitionFunctionParameter extends ScriptNameObjectBase implements ISfcSupportsDesignMode
The PartitionFunctionParameter type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
PartitionFunctionParameter() | Initializes a new instance of the PartitionFunctionParameter class. |
![]() |
PartitionFunctionParameter(PartitionFunction) | Initializes a new instance of the PartitionFunctionParameter class for the specified partition function. |
![]() |
PartitionFunctionParameter(PartitionFunction, DataType) | Initializes a new instance of the PartitionFunctionParameter class with the specified data type and for the specified partition function. |
Top
Properties
Name | Description | |
---|---|---|
![]() |
Collation | Gets or sets the SQL Server collation for the partition function parameter. |
![]() |
ID | Gets the index position of the PartitionFunctionParameter object within the collection. |
![]() |
Length | Gets or sets the length of the parameter in bytes. |
![]() |
Name | Gets or sets a String which contains the name of the PartitionFunctionParameter. (Overrides NamedSmoObject.Name.) |
![]() |
NumericPrecision | Gets or sets the numeric precision of a parameter of a numeric data type. |
![]() |
NumericScale | Gets or sets the numeric scale of a parameter of a numeric data type. |
![]() |
Parent | Gets or sets the PartitionFunction object that is the parent of the PartitionFunctionParameter object. |
![]() |
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
![]() |
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
![]() |
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
Methods
Name | Description | |
---|---|---|
![]() |
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
![]() |
Equals | (Inherited from Object.) |
![]() |
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) |
![]() |
GetContextDB | Gets the context database that is associated with this object. (Inherited from SqlSmoObject.) |
![]() |
GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) |
![]() |
GetHashCode | (Inherited from Object.) |
![]() |
GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
![]() |
GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
![]() |
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
![]() |
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
![]() |
GetType | (Inherited from Object.) |
![]() |
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
![]() |
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
![]() |
IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) |
![]() |
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
![]() |
Refresh | Refreshes the script name. (Inherited from ScriptNameObjectBase.) |
![]() |
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) |
![]() |
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
![]() |
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Events
Name | Description | |
---|---|---|
![]() |
PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) |
![]() |
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() |
IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) |
![]() ![]() |
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.) |
![]() ![]() |
IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObject.GetUrn | Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) |
![]() ![]() |
IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) |
![]() ![]() |
ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.) |
![]() ![]() |
ISfcSupportsDesignMode.IsDesignMode | Gets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. |
Top
Remarks
Partition functions are used to partition tables and indexes across multiple file groups.
To get PartitionFunctionParameter object properties, users can be a member of the public fixed server role.
To set PartitionFunctionParameter object propertied, users must have ALTER permission on the database or ALTER ANY DATASPACE permission on the server or be a member of the db_owner or db_ddladmin fixed database roles or a member of sysadmin fixed server role.
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.
Examples
Using Filegroups and Files to Store Data
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.
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace