Article
10/01/2010

LinkedServer Members

Include Protected Members
Include Inherited Members

A LinkedServer object represents a database system other than SQL Server and is linked to the current instance of SQL Server by using an OLE DB driver.

The LinkedServer type exposes the following members.

Constructors

	Name	Description
	LinkedServer()	Initializes a new instance of the LinkedServer object.
	LinkedServer(Server, String)	Initializes a new instance of the LinkedServer object on the specified instance of SQL Server and with the specified name.

Top

Methods

	Name	Description
	AddDatabaseContext(StringCollection)	(Inherited from SqlSmoObject.)
	Alter()	Updates any LinkedServer object property changes on the instance of SQL Server.
	AlterImpl()	(Inherited from SqlSmoObject.)
	AlterImplFinish(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	AlterImplInit(StringCollection%, ScriptingOptions%)	(Inherited from SqlSmoObject.)
	AlterImplWorker()	(Inherited from SqlSmoObject.)
	BindDefaultImpl(String, String, Boolean)	(Inherited from SqlSmoObject.)
	BindRuleImpl(String, String, Boolean)	(Inherited from SqlSmoObject.)
	CheckCollation(String, ScriptingOptions)	(Inherited from SqlSmoObject.)
	CheckObjectState()	Validates the state of the referenced object. (Inherited from 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. (Inherited from SqlSmoObject.)
	CheckObjectStateImpl(Boolean)	(Inherited from SqlSmoObject.)
	CheckVersion100()	(Inherited from SqlSmoObject.)
	CheckVersion80()	Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
	CheckVersion80SP3()	Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
	CheckVersion90()	Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
	CheckVersionBelow90()	(Inherited from SqlSmoObject.)
	CleanObject()	(Inherited from SqlSmoObject.)
	Create()	Creates a linked server on the instance of SQL Server as defined by the LinkedServer object.
	CreateImpl()	(Inherited from SqlSmoObject.)
	CreateImplFinish(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	CreateImplInit(StringCollection%, ScriptingOptions%)	(Inherited from SqlSmoObject.)
	Discover()	(Inherited from SqlSmoObject.)
	Drop()	Removes the reference to the linked server from the instance of SQL Server.
	Drop(Boolean)	Removes the reference to the linked server from the instance of SQL Server.
	DropImpl()	(Inherited from SqlSmoObject.)
	DropImplWorker(Urn%)	(Inherited from SqlSmoObject.)
	EnumColumns()	Enumerates a list of columns that can be accessed on the linked server.
	EnumColumns(String)	Enumerates a list of columns that can be accessed on the linked server for a specified table.
	EnumColumns(String, String)	Enumerates a list of columns that can be accessed on the linked server for a specified table and schema.
	EnumColumns(String, String, String)	Enumerates a list of columns that can be accessed on the linked server for a specified table, schema, and database.
	EnumColumns(String, String, String, String)	Enumerates a list of columns that can be accessed on the linked server for a specified column.
	EnumScriptImpl(ScriptingOptions)	(Inherited from SqlSmoObject.)
	EnumScriptImplWorker(ScriptingOptions)	(Inherited from SqlSmoObject.)
	EnumTables()	Enumerates a list of tables that are available on the linked server.
	EnumTables(String)	Enumerates a list of tables that are available on the linked server for a specified table name.
	EnumTables(String, String)	Enumerates a list of tables that are available on the linked server for a specified table name and schema.
	EnumTables(String, String, String)	Enumerates a list of tables that are available on the linked server for a specified table name, schema, and database.
	EnumTables(String, String, String, LinkedTableType)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	FormatSqlVariant(Object)	(Inherited from SqlSmoObject.)
	GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean)	(Inherited from SqlSmoObject.)
	GenerateDataSpaceScript(StringBuilder, ScriptingOptions)	(Inherited from SqlSmoObject.)
	GetBindDefaultScript(ScriptingOptions, String, String, Boolean)	(Inherited from SqlSmoObject.)
	GetBindRuleScript(ScriptingOptions, String, String, Boolean)	(Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetDBName()	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%)	(Inherited from SqlSmoObject.)
	GetFragOptionString(FragmentationOption)	(Inherited from SqlSmoObject.)
	GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetHashCode()	(Inherited from Object.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetPropValue(String)	(Inherited from SqlSmoObject.)
	GetPropValueOptional(String)	(Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull(String)	(Inherited from SqlSmoObject.)
	GetRealValue(Property, Object)	(Inherited from SqlSmoObject.)
	GetScriptingOptionsForCreate()	(Inherited from SqlSmoObject.)
	GetServerName()	Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetServerObject()	(Inherited from SqlSmoObject.)
	GetSqlServerVersionName()	Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetType()	(Inherited from Object.)
	GetUrnRecursive(StringBuilder)	(Inherited from SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	(Inherited from SqlSmoObject.)
	ImplInitialize(array<String[], array<OrderBy[])	(Inherited from SqlSmoObject.)
	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.)
	IsObjectDirty()	Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (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.)
	IsVersion80SP3()	(Inherited from SqlSmoObject.)
	MarkDropped()	(Inherited from SqlSmoObject.)
	MarkForDropImpl(Boolean)	(Inherited from SqlSmoObject.)
	MemberwiseClone()	(Inherited from Object.)
	PostAlter()	(Inherited from SqlSmoObject.)
	PostCreate()	(Inherited from SqlSmoObject.)
	PostDrop()	(Inherited from SqlSmoObject.)
	Refresh()	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	RenameImpl(String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	RenameImplWorker(String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	Script()	Generates a Transact-SQL script that can be used to re-create the linked server registration.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the linked server registration as specified by the script options.
	ScriptAlter(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptChangeOwner(StringCollection, ScriptingOptions)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	ScriptCreate(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptDdl(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptDrop(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptImpl()	(Inherited from SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptImplWorker(ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptRename(StringCollection, ScriptingOptions, String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	SetParentImpl(SqlSmoObject)	(Inherited from SqlSmoObject.)
	TestConnection()
	ToString()	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TouchImpl()	(Inherited from SqlSmoObject.)
	UnbindDefaultImpl(Boolean)	(Inherited from SqlSmoObject.)
	UnbindRuleImpl(Boolean)	(Inherited from SqlSmoObject.)
	Validate(String, array<Object[])	(Inherited from SmoObjectBase.)

Top

Fields

	Name	Description
	m_ExtendedProperties	(Inherited from SqlSmoObject.)

Top

Properties

	Name	Description
	Catalog	Gets or sets the database to be used when the linked server is made through a connection to an OLE DB provider. .
	CollationCompatible	Gets or sets the Boolean property value that specifies whether the default collation of the linked server is compatible with the default collation on the local instance of SQL Server.
	CollationName	Gets or sets the name of the collation to use when sorting data from the linked server.
	ConnectTimeout	Gets or sets the number of seconds to wait for a connection to be established with the linked server before timing out.
	DataAccess	Gets or sets the Boolean property value that specifies whether data can be accessed on the linked server.
	DataSource	Gets or sets the data source to be used when the linked server is made through a connection to an OLE DB provider.
	DateLastModified	Gets the date and time when the linked server was last modified.
	DistPublisher	Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
	Distributor	Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
	ID	Gets the ID value that uniquely identifies the linked server.
	IsPromotionofDistributedTransactionsForRPCEnabled	Gets or sets a Boolean property value that specifies whether the promotion of distributed transaction for RPC (remote procedure calls) is enabled.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
	LazySchemaValidation	Gets or sets the Boolean property value that specifies whether the schema used by the linked server data is validated when the local instance of SQL Server is idle or not.
	LinkedServerLogins	Represents a collection of LinkedServerLogin objects. Each LinkedServerLogin object represents a linked server login defined on the linked server.
	Location	Gets or sets the description of the location of the linked server.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	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. (Inherited from SqlSmoObject.)
	Parent	Gets or sets the Server object that is the parent of the LinkedServer object.
	ProductName	Gets or sets the name of the product to which SQL Server can connect through the OLE DB Provider.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ProviderName	Gets or sets the name of the OLE DB provider used to connect to the linked server.
	ProviderString	Gets or sets the connection string used to connect to a linked server by way of the OLE DB Provider.
	Publisher	Gets or sets a Boolean property value that specifies whether the linked server is a replication Publisher or not.
	QueryTimeout	Gets or sets the time in seconds to wait for a query to execute before timing out.
	Rpc	Gets or sets the Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs).
	RpcOut	The Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs) with output parameters.
	ScalarResult	Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Subscriber	Gets or sets the Boolean property value that specifies whether the linked server is a replication Subscriber.
	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.)
	UseRemoteCollation	Gets or sets the Boolean property value that specifies whether to use the collation that is associated with the data from the linked server.

Top

Events

	Name	Description
	PropertyChanged	(Inherited from SqlSmoObject.)
	PropertyMetadataChanged	(Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObjectDiscover()	(Inherited from SqlSmoObject.)
	IAlienObjectGetParent()	(Inherited from SqlSmoObject.)
	IAlienObjectGetProperty(String)	(Inherited from SqlSmoObject.)
	ISfcPropertyProviderGetPropertySet()	(Inherited from SqlSmoObject.)
	IAlienObjectGetUrn()	(Inherited from SqlSmoObject.)
	IAlienObjectResolve(String)	(Inherited from SqlSmoObject.)
	IAlienObjectSetProperty(Object, Object)	(Inherited from SqlSmoObject.)

Top