Function Class

Definition

Namespace:: Microsoft.AnalysisServices.Tabular

Assembly:: Microsoft.AnalysisServices.Tabular.dll

Package:: Microsoft.AnalysisServices v19.103.2

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.

Represents a user-defined function.

public sealed class Function : Microsoft.AnalysisServices.Tabular.NamedMetadataObject, Microsoft.AnalysisServices.Tabular.IMetadataObjectWithLineage

type Function = class
    inherit NamedMetadataObject
    interface IMetadataObjectWithLineage

Public NotInheritable Class Function
Inherits NamedMetadataObject
Implements IMetadataObjectWithLineage

Inheritance: Object

MetadataObject

NamedMetadataObject
Function

Implements: IMetadataObjectWithLineage

Remarks

This metadata object is only supported when the compatibility level of the database is at 1702 or above.

Constructors

Function()

Create a new instance of the Function class with default settings.

Properties

Annotations	Gets the collection object of all annotations in the current Function.
ChangedProperties	Gets the collection object of all changedproperties in the current Function.
Description	The description of the user-defined function, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.
ErrorMessage	A string that explains the error state associated with the current object. It is set by the engine only when the state of the object is one of these three values: SemanticError, DependencyError, or SyntaxError.
Expression	The DAX function parameters and expression.
ExtendedProperties	Gets the collection object of all extendedproperties in the current Function.
IsHidden	A boolean value that indicates whether the function is treated as hidden by client visualization tools. True if the function is treated as hidden by client visualization tools; otherwise false.
IsRemoved	A Boolean specifying whether this object was removed from an object tree. (Inherited from MetadataObject)
LineageTag	A tag that represents the lineage of the object.
Model	Gets the Tabular model that contains this object. (Inherited from MetadataObject)
ModifiedTime	The time that the object was last modified.
Name	Gets or Sets the Name of this object.
ObjectType	Gets the type of object. (Inherited from MetadataObject)
Parent	Gets the parent of the current MetadataObject. (Inherited from MetadataObject)
SourceLineageTag	A tag that represents the lineage of the source for the object.
State	Provides information on the state of the function. Possible values and their interpretation are as follows. Ready (1) The Function is usable. SemanticError (5) The function expression has a semantic error. SyntaxError (9) The function has a syntax error in its expression. All other values are not applicable to Function.
StructureModifiedTime	The time that the structure of the object was last modified.

Methods

Clone()	Creates a new, full copy of a Function object.
CopyFrom(Function)	Obsolete. Deprecated. Use CopyTo method instead.
CopyTo(Function)	Copies a Function object to the specified object.
Rename(String)	Obsolete. Deprecated. Use RequestRename method instead.
RequestRename(String)	Request rename of this object.
Validate()	This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only. (Inherited from MetadataObject)

Applies to

Share via