Share via

IBuiltInFunction Interface

  • Article

Represents a built-in function or a system function that starts with two at signs (@@).

Namespace:  Microsoft.SqlServer.Management.SqlParser.Metadata
Assembly:  Microsoft.SqlServer.Management.SqlParser (in Microsoft.SqlServer.Management.SqlParser.dll)

Syntax

'Declaration
Public Interface IBuiltInFunction _
    Inherits IScalarFunction, IFunction, IFunctionModuleBase, IScalar,  _
    IMetadataObject
'Usage
Dim instance As IBuiltInFunction

public interface IBuiltInFunction : IScalarFunction, 
    IFunction, IFunctionModuleBase, IScalar, IMetadataObject

public interface class IBuiltInFunction : IScalarFunction, 
    IFunction, IFunctionModuleBase, IScalar, IMetadataObject

type IBuiltInFunction =  
    interface 
        interface IScalarFunction 
        interface IFunction 
        interface IFunctionModuleBase 
        interface IScalar 
        interface IMetadataObject 
    end

public interface IBuiltInFunction extends IScalarFunction, IFunction, IFunctionModuleBase, IScalar, IMetadataObject

The IBuiltInFunction type exposes the following members.

Properties

  Name Description
Public property DataType Gets the scalar data type. (Inherited from IScalar.)
Public property IsAggregateFunction Gets a value that indicates whether this is an aggregate function. (Inherited from IScalarFunction.)
Public property IsDatePartFunction Gets a value that indicates whether the function is a date-and-time parts function (for example, DATEDIFF, DATEPART, and so on).
Public property IsGlobalVariable Gets a value that indicates whether this is a system function that starts with two at signs (@@) (for example, @@IDENTITY).
Public property IsVarArg Gets a value that indicates whether the number of arguments is variable.
Public property MaxNumberOfArgs Gets the maximum number of arguments that the function accepts.
Public property MinNumberOfArgs Gets the minimum number of arguments that the function accepts.
Public property Name Gets the name of the metadata object. (Inherited from IMetadataObject.)
Public property Nullable Gets a Boolean value that indicates whether the scalar object is nullable. (Inherited from IScalar.)
Public property Parameters Gets a collection that contains the parameters that the function or module accepts. (Inherited from IFunctionModuleBase.)
Public property ScalarType Gets the scalar type. (Inherited from IScalar.)

Top

Methods

  Name Description
Public method Accept<T> Accepts a visit from the specified IMetadataObjectVisitor<T> object. (Inherited from IMetadataObject.)

Top

See Also

Reference

Microsoft.SqlServer.Management.SqlParser.Metadata Namespace