UserDefinedAggregateParameter Class

The UserDefinedAggregateParameter object represents the parameters that are used with a user-defined aggregate.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ParameterBase
            Microsoft.SqlServer.Management.Smo.UserDefinedAggregateParameter

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

Syntax

'Declaration
Public NotInheritable Class UserDefinedAggregateParameter _
    Inherits ParameterBase _
    Implements ISfcSupportsDesignMode
'Usage
Dim instance As UserDefinedAggregateParameter

public sealed class UserDefinedAggregateParameter : ParameterBase, 
    ISfcSupportsDesignMode

public ref class UserDefinedAggregateParameter sealed : public ParameterBase, 
    ISfcSupportsDesignMode

[<SealedAttribute>]
type UserDefinedAggregateParameter =  
    class 
        inherit ParameterBase 
        interface ISfcSupportsDesignMode 
    end

public final class UserDefinedAggregateParameter extends ParameterBase implements ISfcSupportsDesignMode

The UserDefinedAggregateParameter type exposes the following members.

Constructors

	Name	Description
	UserDefinedAggregateParameter()	Initializes a new instance of the UserDefinedAggregateParameter class.
	UserDefinedAggregateParameter(UserDefinedAggregate, String)	Initializes a new instance of the UserDefinedAggregateParameter class on the specified user-defined aggregate and with the specified name.
	UserDefinedAggregateParameter(UserDefinedAggregate, String, DataType)	Initializes a new instance of the UserDefinedAggregateParameter class on the specified user-defined aggregate, with the specified name and with the specified data type.

Top

Properties

	Name	Description
	DataType	Gets or sets the DataType which represents the data type of the UserDefinedAggregateParameter (Overrides ParameterBase.DataType.)
	ExtendedProperties	Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the ParameterBase object. (Inherited from ParameterBase.)
	ID	Gets the ID value that uniquely identifies the user-defined aggregate parameter.
	Name	Gets or sets a String value that specifies the name of the parameter. (Overrides ParameterBase.Name.)
	Parent	Gets the UserDefinedAggregate object that is the parent of the UserDefinedAggregateParameter object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	MarkForDrop	Marks the foreign key to be dropped next time its parent object is altered by the Alter method. (Inherited from ParameterBase.)
	Refresh	Refreshes the ParameterBase object. (Inherited from ParameterBase.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that specifies whether the parameter supports design mode.

Top

Remarks

To get UserDefinedAggregateParameter object properties, users can be a member of the public fixed server role.

To set UserDefinedAggregateParameter object properties, users must have CREATE AGGREGATE permission on the database and also REFERENCES permission on the specified assembly.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

CREATE AGGREGATE (Transact-SQL)