Back to Devexpress

ConnectionProviderSql.UnregisterCustomAggregate(String) Method

corelibraries-devexpress-dot-xpo-dot-db-dot-connectionprovidersql-dot-unregistercustomaggregate-x28-system-dot-string-x29.md

latest2.1 KB
Original Source

ConnectionProviderSql.UnregisterCustomAggregate(String) Method

Unregisters a custom aggregate function with the specified name from use in any ConnectionProviderSql-based connection provider in your application.

Namespace : DevExpress.Xpo.DB

Assembly : DevExpress.Data.v25.2.dll

NuGet Package : DevExpress.Data

Declaration

csharp
public bool UnregisterCustomAggregate(
    string functionName
)
vb
Public Function UnregisterCustomAggregate(
    functionName As String
) As Boolean

Parameters

NameTypeDescription
functionNameString

A custom aggregate function’s name. This value cannot be null ( Nothing in Visual Basic) or match a standard aggregate name: Sum, Min, Max, Avg, Count, Exists, or Single.

|

Returns

TypeDescription
Boolean

true , if a custom aggregate function whose name matches the functionName was unregistered successfully; otherwise, false.

|

Remarks

To remove a custom aggregate function instance, call the UnregisterCustomAggregate(ICustomAggregateFormattable) overloaded method and pass the instance as its parameter.

See Also

ConnectionProviderSql Class

ConnectionProviderSql Members

DevExpress.Xpo.DB Namespace