IScalarValuedFunction Interface

  • Article

Represents a SQL Server scalar-valued function.

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

Syntax

'Declaration
Public Interface IScalarValuedFunction _
    Inherits IUserDefinedFunction, ICallableModule, IUserDefinedFunctionModuleBase, ISchemaOwnedObject,  _
    IDatabaseObject, IScalarFunction, IFunction, IFunctionModuleBase, IScalar,  _
    IMetadataObject
'Usage
Dim instance As IScalarValuedFunction

public interface IScalarValuedFunction : IUserDefinedFunction, 
    ICallableModule, IUserDefinedFunctionModuleBase, ISchemaOwnedObject, IDatabaseObject, IScalarFunction, 
    IFunction, IFunctionModuleBase, IScalar, IMetadataObject

public interface class IScalarValuedFunction : IUserDefinedFunction, 
    ICallableModule, IUserDefinedFunctionModuleBase, ISchemaOwnedObject, IDatabaseObject, IScalarFunction, 
    IFunction, IFunctionModuleBase, IScalar, IMetadataObject

type IScalarValuedFunction =  
    interface 
        interface IUserDefinedFunction 
        interface ICallableModule 
        interface IUserDefinedFunctionModuleBase 
        interface ISchemaOwnedObject 
        interface IDatabaseObject 
        interface IScalarFunction 
        interface IFunction 
        interface IFunctionModuleBase 
        interface IScalar 
        interface IMetadataObject 
    end

public interface IScalarValuedFunction extends IUserDefinedFunction, ICallableModule, IUserDefinedFunctionModuleBase, ISchemaOwnedObject, IDatabaseObject, IScalarFunction, IFunction, IFunctionModuleBase, IScalar, IMetadataObject

The IScalarValuedFunction type exposes the following members.

Properties

  Name Description
Public property BodyText Gets the Transact-SQL string that defines the module. (Inherited from IUserDefinedFunction.)
Public property DataType Gets the scalar data type. (Inherited from IScalar.)
Public property ExecutionContext Gets the IExecutionContext object that specifies the module execution context. (Inherited from IUserDefinedFunctionModuleBase.)
Public property IsAggregateFunction Gets a value that indicates whether this is an aggregate function. (Inherited from IScalarFunction.)
Public property IsEncrypted Gets a value that indicates whether the module is encrypted. (Inherited from IUserDefinedFunctionModuleBase.)
Public property IsQuotedIdentifierOn Gets a Boolean value that indicates whether the unique identifier option is on. (Inherited from IUserDefinedFunction.)
Public property IsSchemaBound Gets a value that indicates whether the user-defined function is bound to a schema. (Inherited from IUserDefinedFunction.)
Public property IsSqlClr Gets a value that indicates whether this is a CLR module. (Inherited from IUserDefinedFunction.)
Public property IsSystemObject Gets a value that indicates whether this is a system object. (Inherited from IDatabaseObject.)
Public property ModuleType Gets the module type. (Inherited from ICallableModule.)
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 Parent Gets the IDatabaseObject object that is the parent of this object. (Inherited from IDatabaseObject.)
Public property ReturnsNullOnNullInput Gets a value that indicates whether to call the function if at least one of the function arguments is null.
Public property ReturnType Gets the scalar data type of the module return value. (Inherited from ICallableModule.)
Public property ScalarType Gets the scalar type. (Inherited from IScalar.)
Public property Schema Gets the ISchema object that owns this object. (Inherited from ISchemaOwnedObject.)

Top

Methods

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

Top

See Also

Reference

Microsoft.SqlServer.Management.SqlParser.Metadata Namespace