Synonym.BaseObject Property

Gets or sets the base object for which the synonym is defined.

This API is not CLS-compliant. 

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcReferenceAttribute(GetType(View), "Server[@Name = '{0}']/Database[@Name = '{1}']/View[@Name='{2}' and @Schema='{3}']",  _
    )> _
<SfcReferenceAttribute(GetType(UserDefinedAggregate), "Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedAggregate[@Name='{2}' and @Schema='{3}']",  _
    )> _
<SfcReferenceAttribute(GetType(UserDefinedFunction), "Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedFunction[@Name='{2}' and @Schema='{3}']",  _
    )> _
<SfcPropertyAttribute(SfcPropertyFlags.None Or SfcPropertyFlags.ReadOnlyAfterCreation Or SfcPropertyFlags.Standalone Or SfcPropertyFlags.SqlAzureDatabase Or SfcPropertyFlags.Design)> _
<SfcReferenceAttribute(GetType(Table), "Server[@Name = '{0}']/Database[@Name = '{1}']/Table[@Name='{2}' and @Schema='{3}']",  _
    )> _
<CLSCompliantAttribute(False)> _
<SfcReferenceAttribute(GetType(StoredProcedure), "Server[@Name = '{0}']/Database[@Name = '{1}']/StoredProcedure[@Name='{2}' and @Schema='{3}']",  _
    )> _
Public Property BaseObject As String 
    Get 
    Set
'Usage
Dim instance As Synonym 
Dim value As String 

value = instance.BaseObject

instance.BaseObject = value

[SfcReferenceAttribute(typeof(View), "Server[@Name = '{0}']/Database[@Name = '{1}']/View[@Name='{2}' and @Schema='{3}']", 
    )]
[SfcReferenceAttribute(typeof(UserDefinedAggregate), "Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedAggregate[@Name='{2}' and @Schema='{3}']", 
    )]
[SfcReferenceAttribute(typeof(UserDefinedFunction), "Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedFunction[@Name='{2}' and @Schema='{3}']", 
    )]
[SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.ReadOnlyAfterCreation|SfcPropertyFlags.Standalone|SfcPropertyFlags.SqlAzureDatabase|SfcPropertyFlags.Design)]
[SfcReferenceAttribute(typeof(Table), "Server[@Name = '{0}']/Database[@Name = '{1}']/Table[@Name='{2}' and @Schema='{3}']", 
    )]
[CLSCompliantAttribute(false)]
[SfcReferenceAttribute(typeof(StoredProcedure), "Server[@Name = '{0}']/Database[@Name = '{1}']/StoredProcedure[@Name='{2}' and @Schema='{3}']", 
    )]
public string BaseObject { get; set; }

[SfcReferenceAttribute(typeof(View), L"Server[@Name = '{0}']/Database[@Name = '{1}']/View[@Name='{2}' and @Schema='{3}']", 
    )]
[SfcReferenceAttribute(typeof(UserDefinedAggregate), L"Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedAggregate[@Name='{2}' and @Schema='{3}']", 
    )]
[SfcReferenceAttribute(typeof(UserDefinedFunction), L"Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedFunction[@Name='{2}' and @Schema='{3}']", 
    )]
[SfcPropertyAttribute(SfcPropertyFlags::None|SfcPropertyFlags::ReadOnlyAfterCreation|SfcPropertyFlags::Standalone|SfcPropertyFlags::SqlAzureDatabase|SfcPropertyFlags::Design)]
[SfcReferenceAttribute(typeof(Table), L"Server[@Name = '{0}']/Database[@Name = '{1}']/Table[@Name='{2}' and @Schema='{3}']", 
    )]
[CLSCompliantAttribute(false)]
[SfcReferenceAttribute(typeof(StoredProcedure), L"Server[@Name = '{0}']/Database[@Name = '{1}']/StoredProcedure[@Name='{2}' and @Schema='{3}']", 
    )]
public:
property String^ BaseObject {
    String^ get ();
    void set (String^ value);
}

[<SfcReferenceAttribute(typeof(View), "Server[@Name = '{0}']/Database[@Name = '{1}']/View[@Name='{2}' and @Schema='{3}']", 
    )>]
[<SfcReferenceAttribute(typeof(UserDefinedAggregate), "Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedAggregate[@Name='{2}' and @Schema='{3}']", 
    )>]
[<SfcReferenceAttribute(typeof(UserDefinedFunction), "Server[@Name = '{0}']/Database[@Name = '{1}']/UserDefinedFunction[@Name='{2}' and @Schema='{3}']", 
    )>]
[<SfcPropertyAttribute(SfcPropertyFlags.None|SfcPropertyFlags.ReadOnlyAfterCreation|SfcPropertyFlags.Standalone|SfcPropertyFlags.SqlAzureDatabase|SfcPropertyFlags.Design)>]
[<SfcReferenceAttribute(typeof(Table), "Server[@Name = '{0}']/Database[@Name = '{1}']/Table[@Name='{2}' and @Schema='{3}']", 
    )>]
[<CLSCompliantAttribute(false)>]
[<SfcReferenceAttribute(typeof(StoredProcedure), "Server[@Name = '{0}']/Database[@Name = '{1}']/StoredProcedure[@Name='{2}' and @Schema='{3}']", 
    )>]
member BaseObject : string with get, set

function get BaseObject () : String 
function set BaseObject (value : String)

Property Value

Type: System.String
A String value that specifies the base object for the synonym.

Examples

Using Synonyms

See Also

Reference

Synonym Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

CREATE SYNONYM (Transact-SQL)