NotificationClass.ComputedFieldDigestGrouping Method

Article
12/03/2008

Returns a value indicating if the computed field is used to determine the grouping of digest notifications.

Namespace: Microsoft.SqlServer.NotificationServices
Assembly: Microsoft.SqlServer.NotificationServices (in microsoft.sqlserver.notificationservices.dll)

Syntax

'Declaration
Public Function ComputedFieldDigestGrouping ( _
    fieldOrdinal As Integer _
) As Boolean

public bool ComputedFieldDigestGrouping (
    int fieldOrdinal
)

public:
virtual bool ComputedFieldDigestGrouping (
    int fieldOrdinal
) sealed

public final boolean ComputedFieldDigestGrouping (
    int fieldOrdinal
)

public final function ComputedFieldDigestGrouping (
    fieldOrdinal : int
) : boolean

Parameters

fieldOrdinal
The zero-based ordinal of a developer-defined computed field in the notification class.

Return Value

true if the computed field is used to determine digest grouping; otherwise false.

Remarks

For more information about digest delivery, see Specifying Digest or Multicast Delivery.

Example

Dim instanceName As String = "MyInstanceName"
Dim applicationName As String = "MyApplicationName"
Dim notificationClassName As String = "MyNotificationClassName"
Dim fieldOrdinal As Integer = 0

'Create an NSInstance object.
Dim myInstance As New NSInstance(instanceName)

'Create an NSApplication object.
Dim myApplication As New NSApplication(myInstance, applicationName)

'Create a NotificationClassEnumeration object.
Dim myNotificationClassEnumeration As _
    New NotificationClassEnumeration(myApplication)

'Use the NotificationClassEnumeration.Item 
'to return a NotificationClass object.
Dim myNotificationClass As NotificationClass = _
    myNotificationClassEnumeration(notificationClassName)

'Use the ComputedFieldDigestGrouping method to get 
'a computed field's digest grouping value.
Dim isDigest As Boolean = _
    myNotificationClass.ComputedFieldDigestGrouping(fieldOrdinal)

string instanceName = "MyInstanceName";
string applicationName = "MyApplicationName";
string notificationClassName = "MyNotificationClassName";
int fieldOrdinal = 0;

//Create an NSInstance object.
NSInstance myInstance = new NSInstance(instanceName);

//Create an NSApplication object.
NSApplication myApplication = 
    new NSApplication(myInstance, applicationName);

//Create a NotificationClassEnumeration object.
NotificationClassEnumeration myNotificationClassEnumeration = 
    new NotificationClassEnumeration(myApplication);

//Use the NotificationClassEnumeration.Item 
//to return a NotificationClass object.
NotificationClass myNotificationClass = 
    myNotificationClassEnumeration[notificationClassName];

//Use the ComputedFieldDigestGrouping method to get 
//a computed field's digest grouping value.
bool isDigest = myNotificationClass.ComputedFieldDigestGrouping(
    fieldOrdinal);

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms