Classe Parameter
The Parameter class represents a parameter. It is a base class that is inherited by the StoredProcedureParameter class and the UserDefinedFunctionParameter class and contains common features of both classes.
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.ParameterBase
Microsoft.SqlServer.Management.Smo.Parameter
Microsoft.SqlServer.Management.Smo.NumberedStoredProcedureParameter
Microsoft.SqlServer.Management.Smo.StoredProcedureParameter
Microsoft.SqlServer.Management.Smo.UserDefinedFunctionParameter
Espace de noms : Microsoft.SqlServer.Management.Smo
Assembly : Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)
Syntaxe
'Déclaration
Public Class Parameter _
Inherits ParameterBase _
Implements ISfcSupportsDesignMode
'Utilisation
Dim instance As Parameter
public class Parameter : ParameterBase, ISfcSupportsDesignMode
public ref class Parameter : public ParameterBase,
ISfcSupportsDesignMode
type Parameter =
class
inherit ParameterBase
interface ISfcSupportsDesignMode
end
public class Parameter extends ParameterBase implements ISfcSupportsDesignMode
Le type Parameter expose les membres suivants.
Constructeurs
| Nom | Description | |
|---|---|---|
.gif "Méthode protégée") |
Parameter | Initializes a new instance of the Parameter class. |
Haut de la page
Propriétés
| Nom | Description | |
|---|---|---|
.gif "Propriété publique") |
DataType | Gets or sets the data type associated with the parameter. (hérité de ParameterBase.) |
|
DefaultValue | Gets or sets the default value of the parameter. |
.gif "Propriété protégée") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (hérité de SqlSmoObject.) |
|
ExtendedProperties | Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the ParameterBase object. (hérité de ParameterBase.) |
|
ID | Gets the ID value that uniquely identifies the parameter. |
|
IsReadOnly | Gets or sets whether the parameter is read only. |
|
IsTouched | Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (hérité de SqlSmoObject.) |
|
Name | Gets or sets a String value that specifies the name of the parameter. (hérité de ParameterBase.) |
|
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. (hérité de SqlSmoObject.) |
|
Properties | Gets a collection of Property objects that represent the object properties. (hérité de SqlSmoObject.) |
|
ScalarResult | Gets the scalar result for the referenced object. (hérité de SqlSmoObject.) |
|
State | Gets the state of the referenced object. (hérité de SmoObjectBase.) |
|
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 | |
|---|---|---|
|
AddDatabaseContext | Add the database context to the collection of queries identified by the queries parameter. (hérité de SqlSmoObject.) |
|
AlterImpl | Activates the object altered event. (hérité de SqlSmoObject.) |
|
AlterImplWorker | Calls the Alter methods. (hérité de SqlSmoObject.) |
|
AppendCommaText | Appends text, optionally separated by a comma. (hérité de ScriptNameObjectBase.) |
|
AppendWithCommaText | Appends text, optionally separated by a comma. (hérité de ScriptNameObjectBase.) |
|
AppendWithOption | Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (hérité de ScriptNameObjectBase.) |
|
AutoGenerateName | Generates a name based on the object Guid. (hérité de ScriptNameObjectBase.) |
|
BindDefaultImpl | Binds the default items identified by the parameters. (hérité de SqlSmoObject.) |
|
BindRuleImpl | Binds the rule schema to the rule and columns identified by the parameters. (hérité de SqlSmoObject.) |
|
CheckObjectDirty | Checks whether object has been modified and not persisted. (hérité de ScriptNameObjectBase.) |
|
CheckObjectState() | Validates the state of the referenced object. (hérité de SqlSmoObject.) |
|
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. (hérité de SqlSmoObject.) |
|
CheckObjectStateImpl | Checks the state of a SqlSmoObject. (hérité de SqlSmoObject.) |
|
CheckParamName | Checks the parameter name. (hérité de ParameterBase.) |
|
CheckTextCorectness | Checks text for correctness against the parameters. (hérité de ScriptNameObjectBase.) |
|
CheckTextModeSupport | Checks mode of support. (hérité de ScriptNameObjectBase.) |
|
CheckVersion100 | Checks whether version of SQL Server is SQL Server 2008. (hérité de SqlSmoObject.) |
|
CheckVersion110() | Checks whether version of SQL Server is SQL Server 2012. (hérité de SqlSmoObject.) |
|
CheckVersion110(String) | Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (hérité de SqlSmoObject.) |
|
CheckVersion80 | Checks the validity of the object on SQL Server 2000. (hérité de SqlSmoObject.) |
|
CheckVersion80SP3 | Checks the validity of the object on SQL Server 2000 SP3. (hérité de SqlSmoObject.) |
|
CheckVersion90 | Check the validity of the object on SQL Server 2005. (hérité de SqlSmoObject.) |
|
CheckVersionBelow110 | Checks whether version of SQL Server is before SQL Server 2012. (hérité de SqlSmoObject.) |
|
CheckVersionBelow90 | Checks whether version of SQL Server is before SQL Server 2005. (hérité de SqlSmoObject.) |
|
CleanObject | Cleans the referenced object. (hérité de ScriptNameObjectBase.) |
|
CreateImpl | Creates an object with scripting options. (hérité de SqlSmoObject.) |
.gif "Méthode publique") |
Discover | Discovers a list of type Object. (hérité de SqlSmoObject.) |
|
DropImpl | Drops a SqlSmoObject. (hérité de SqlSmoObject.) |
|
DropImplWorker | Calls the drop methods. (hérité de SqlSmoObject.) |
|
Equals | (hérité de Object.) |
|
ExecuteNonQuery | Executes a batch of statements that does not return a result set. (hérité de SqlSmoObject.) |
|
ExecuteRenameQuery | Executes the rename query for the object. (hérité de NamedSmoObject.) |
|
Finalize | (hérité de Object.) |
|
ForceTextModeOnTextBody | Enforces text mode on the text body. (hérité de ScriptNameObjectBase.) |
|
FormatSqlVariant | Formats an object as SqlVariant type. (hérité de SqlSmoObject.) |
|
GenerateAlterEvent() | Generates the alter event with the specified value. (hérité de SqlSmoObject.) |
|
GenerateAlterEvent(Urn, Object) | Generates alter event with the specified URN and inner object value. (hérité de SqlSmoObject.) |
|
GetBraketNameForText | Gets the bracket name for the text. (hérité de ScriptNameObjectBase.) |
|
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.) |
|
GetFragOptionString | Gets a FragmentationOption object as a string value. (hérité de SqlSmoObject.) |
|
GetHashCode | (hérité de Object.) |
|
GetIsSystemNamed | Gets a Boolean value that specifies whether the system is named. (hérité de ScriptNameObjectBase.) |
|
GetIsTextDirty | Determines whether the text value is consistent with stored value. (hérité de ScriptNameObjectBase.) |
|
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.) |
|
GetRealValue | Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.) |
|
GetServerName | Gets the name of the instance of SQL Server with which the object is associated. (hérité de SqlSmoObject.) |
|
GetServerObject | Gets the server of the SqlSmoObject object. (hérité de SqlSmoObject.) |
|
GetSqlServerVersionName | Gets the version name of the instance of SQL Server with which the object is associated. (hérité de SqlSmoObject.) |
|
GetTextBody() | Returns the text body. (hérité de ScriptNameObjectBase.) |
|
GetTextBody(Boolean) | Returns the text body. (hérité de ScriptNameObjectBase.) |
|
GetTextHeader | Returns the text header. (hérité de ScriptNameObjectBase.) |
|
GetTextMode | Determines whether the script name is using text mode. (hérité de ScriptNameObjectBase.) |
|
GetTextProperty | Gets the text of the object, if not available, throw appropriate exception based on the state of the object. (hérité de ScriptNameObjectBase.) |
|
GetType | (hérité de Object.) |
|
GetUrnRecursive(StringBuilder) | Assigns an Urn object of the SqlSmoObject object. (hérité de SqlSmoObject.) |
|
GetUrnRecursive(StringBuilder, UrnIdOption) | Assigns an Urn object of the SqlSmoObject object. (hérité de SqlSmoObject.) |
|
ImplInitialize | Initializes the fields of the SqlSmoObject object. (hérité de SqlSmoObject.) |
|
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.) |
|
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. (hérité de ScriptNameObjectBase.) |
|
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.) |
|
isParentClrImplemented | Gets a Boolean which indicates whether the parent object is implemented in CLR. (hérité de ParameterBase.) |
|
IsVersion80SP3 | Determines whether the version of SQL Server is SQL Server 2000 with SP3. (hérité de SqlSmoObject.) |
|
IsVersion90AndAbove | Determines whether the version of SQL Server is SQL Server 2005 or later. (hérité de SqlSmoObject.) |
|
MarkDropped | Sets the SqlSmoState to dropped. (hérité de SqlSmoObject.) |
|
MarkForDrop | Marks the foreign key to be dropped next time its parent object is altered by the Alter method. (hérité de ParameterBase.) |
|
MarkForDropImpl | Sets the SqlSmoState for drop operation. (hérité de SqlSmoObject.) |
|
MemberwiseClone | (hérité de Object.) |
|
PostAlter | The method that is activated after the SqlSmoObject is altered. (hérité de SqlSmoObject.) |
|
PostCreate | The method that is activated after the SqlSmoObject is created. (hérité de SqlSmoObject.) |
|
PostDrop | The method that is activated after the SqlSmoObject is dropped. (hérité de SqlSmoObject.) |
|
Refresh | Refreshes the ParameterBase object. (hérité de ParameterBase.) |
|
RenameImpl | This method supports the SMO infrastructure and is not intended to be used directly from your code. (hérité de NamedSmoObject.) |
|
RenameImplWorker | Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie. (hérité de NamedSmoObject.) |
|
ScriptImpl() | Gets a collection of scripts of the SqlSmoObject. (hérité de SqlSmoObject.) |
|
ScriptImpl(ScriptingOptions) | Gets a collection of scripts of the SqlSmoObject. (hérité de SqlSmoObject.) |
|
SetCollectionTextMode | Sets the collection text mode. (hérité de ScriptNameObjectBase.) |
|
SetIsSystemNamed | Sets a Boolean value that specifies whether the system is named. (hérité de ScriptNameObjectBase.) |
|
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (hérité de SqlSmoObject.) |
|
SetSchemaOwned | Sets the schema owned value. (hérité de NamedSmoObject.) |
|
SetTextBody | Specifies the text body. (hérité de ScriptNameObjectBase.) |
|
SetTextHeader | Specifies the text header. (hérité de ScriptNameObjectBase.) |
|
SetTextMode | Specifies the text mode. (hérité de ScriptNameObjectBase.) |
|
SwitchTextMode | Switches the text mode. (hérité de ScriptNameObjectBase.) |
|
ThrowIfTextIsDirtyForAlter | Throws an exception of text has been modified and not persisted. (hérité de ScriptNameObjectBase.) |
|
ToString | Returns a String that represents the referenced object. (hérité de SqlSmoObject.) |
|
TouchImpl | Not implemented. (hérité de SqlSmoObject.) |
|
UnbindDefaultImpl | Unbinds the default columns of the SqlSmoObject. (hérité de SqlSmoObject.) |
|
UnbindRuleImpl | Unbinds rules of the SqlSmoObject. (hérité de SqlSmoObject.) |
|
Validate | Validates the state of an object. (hérité de SmoObjectBase.) |
Haut de la page
Événements
| Nom | Description | |
|---|---|---|
.gif "Événement public") |
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
Champs
| Nom | Description | |
|---|---|---|
.gif "Champ protégé") |
m_ExtendedProperties | Represents a property that is defined to extend the properties provided by a SqlSmoObject. (hérité de SqlSmoObject.) |
|
singletonParent | Represents the singleton parent. (hérité de SqlSmoObject.) |
Haut de la page
Implémentations d'interfaces explicites
| Nom | Description | |
|---|---|---|
.gif "Implémentation d'interface explicite") .gif "Méthode privée") |
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.) |
.gif "Propriété privée") |
ISfcSupportsDesignMode.IsDesignMode | Gets a Boolean value that indicates whether the object supports design mode. Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie. |
Haut de la page
Notes
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.