SqlFunctionAttribute.TableDefinition Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Server

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Assembly:: Microsoft.SqlServer.Server.dll

Package:: System.Data.SqlClient v4.8.5

Package:: Microsoft.SqlServer.Server v1.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A string that represents the table definition of the results, if the method is used as a table-valued function (TVF).

public:
 property System::String ^ TableDefinition { System::String ^ get(); void set(System::String ^ value); };

public string TableDefinition { get; set; }

member this.TableDefinition : string with get, set

Public Property TableDefinition As String

Property Value

String

A String value representing the table definition of the results.

Examples

// using Microsoft.Data.SqlClient.Server;

public partial class UserDefinedFunctions
{
    [SqlFunction(Name = "sp_tableFunc", TableDefinition = "letter nchar(1)")]
    public static IEnumerable SampleTableFunction(SqlString s)
    {
        //...
        return new ArrayList(new char[3] { 'a', 'b', 'c' });
    }
}

Remarks

This attribute is used only by Microsoft Visual Studio to automatically register the specified method as a TVF. It is not used by SQL Server.

The following example specifies that the user-defined function is referenced using the name sp_tableFunc. The TableDefinition property has the value letter nchar(1).

Applies to