adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetLogMessagesWithRecordCount Method
Query parameters specifying the messages to return
Returns the total number of records that match the query parameters. See Remarks.


In This Topic
    GetLogMessagesWithRecordCount Method
    In This Topic
    Gets log messages matching a filter and returns a count of the records available
    Syntax
    'Declaration
     
    
    <NotNullAttribute()>
    Public Function GetLogMessagesWithRecordCount( _
       ByVal parameters As LogQueryParameters, _
       ByRef recordCount As Integer _
    ) As LogMessageCollection
    [NotNull()]
    public LogMessageCollection GetLogMessagesWithRecordCount( 
       LogQueryParameters parameters,
       out int recordCount
    )
    [NotNull()]
    public:
    LogMessageCollection^ GetLogMessagesWithRecordCount( 
       LogQueryParameters^ parameters,
       [Out] int recordCount
    ) 

    Parameters

    parameters
    Query parameters specifying the messages to return
    recordCount
    Returns the total number of records that match the query parameters. See Remarks.
    Remarks

    Use this method when you want to return a limited number of records but also report the total number of records available. In the parameters set ArcanaDevelopment.adTempus.Shared.JobQueryParameters.PageSize to the maximum number of records you want to return and ArcanaDevelopment.adTempus.Shared.JobQueryParameters.PageNumber to 1. This method will count the total number of records that match the parameters and return that count in recordCount, but will return no more than ArcanaDevelopment.adTempus.Shared.JobQueryParameters.PageSize records in the returned collection.

    The returned collection of messages is filtered to include only messages that the caller has permission to view. In some circumstances (such as when the parameters does not filter by job) the recordCount may indicate the total number of records without security filtering applied. Therefore repeated calls to this method (with a new PageNumber) may return fewer thant recordCount messages before indicating that no more records are available.

    See Also