Share via

RegisteredServer Members

Include Protected Members
Include Inherited Members

The RegisteredServer class represents a SQL Server registered server.

The RegisteredServer type exposes the following members.

Constructors

  Name Description
Public method RegisteredServer() Initializes a new instance of the RegisteredServer class.
Public method RegisteredServer(String) Initializes a new instance of the RegisteredServer class that has the specified name.
Public method RegisteredServer(ServerGroup, String)

Top

Methods

  Name Description
Public method Alter() Updates any RegisteredServer object property changes on the instance of SQL Server. 
Protected method AlterImpl() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method CheckObjectCreated() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method CheckObjectState() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method Create() Creates a registered server on the instance of SQL Server as defined by the RegisteredServer object.
Protected method CreateIdentityKey() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method CreateImpl() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method Discover(ISfcDependencyDiscoveryObjectSink) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method Drop() Drops the registered server.
Protected method DropImpl() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method Equals(Object) (Inherited from Object.)
Public method Export(String, CredentialPersistenceType) Exports the registered server to the specified file and using the given credential persistence type.
Protected method Finalize() (Inherited from Object.)
Protected method GetChildCollection(String) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method GetConnectionObject() Returns the SFC interface object that represents the connection to the instance of SQL Server.
Public method GetDomain() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method GetHashCode() (Inherited from Object.)
Public methodStatic member GetObjectFactory() Returns the SFC object factory for the RegisteredServer object.
Public method GetPropertySet() Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType() (Inherited from Object.)
Protected method GetTypeMetadataImpl() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method InitializeUIPropertyState() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method MarkForDropImpl(Boolean) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method MarkRootAsConnected() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method MemberwiseClone() (Inherited from Object.)
Public method Move(ServerGroup)
Protected method MoveImpl(SfcInstance) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges(PropertyChangedEventArgs) Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Protected method PostAlter(Object) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method PostCreate(Object) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method PostDrop(Object) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method PostMove(Object) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method PostRename(Object) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method Refresh() Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Public method Rename(SfcKey)
Public method Rename(String) Renames the RegisteredServer object by using the specified name.
Protected method RenameImpl(SfcKey) Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method ResetKey() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method Serialize(XmlWriter) Serializes the instance to XML. (Inherited from SfcInstance.)
Public method ToString() Returns a string representation of the instance Urn. (Inherited from SfcInstance.)
Protected method UpdateUIPropertyState() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Protected method Validate() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public method Validate(String, array<Object[]) Validates the RegisteredServer object against the specified method and arguments.

Top

Properties

  Name Description
Protected property AbstractIdentityKey() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public property ConnectionString Gets or sets the connection string that is used to connect to the instance of SQL Server.
Public property ConnectionStringWithEncryptedPassword Gets the connection string that is used to connect to the instance of SQL Server that has the encrypted password. 
Public property CredentialPersistenceType Gets or sets how the logins and passwords are persisted on the registered server.
Public property CustomConnectionColorArgb
Public property Description Gets the name of the registered server.
Public property ID Gets the ID value that uniquely identifies the registered server.
Public property IdentityKey Gets the key value that uniquely identifies the registered server.
Public property IsDropped Gets the Boolean value that specifies whether the registered server has been dropped or not.
Public property IsLocal Gets the Boolean value that specifies whether the registered server is local or not.
Public property Metadata() Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public property Name Gets the name of the registered server key.
Public property Parent Gets the parent of the RegisteredServer object.
Public property Properties() Returns a collection instance properties. (Inherited from SfcInstance.)
Protected property PropertyStorageProvider() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public property SecureConnectionString Gets or sets the secure string that is used to connect to the instance of SQL Server.
Public property ServerName Gets or sets the name of the server that is associated with the registered server.
Public property ServerType Gets or the kind of server that is associated with the registered server.
Protected property State() Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public property Urn() Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)
Public property UseCustomConnectionColor

Top

Events

  Name Description
Protected event propertyChanged() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public event PropertyChanged() CLS-compliant event for property changes. (Inherited from SfcInstance.)
Protected event propertyMetadataChanged() Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged() CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

  • Last updated on