ISLoadMessagesParams.StartIndex

Description

The index of the first item from the collection loaded on the basis of the selected filter which will be included in the result set of messages.

Syntax

object.StartIndex

Part Attribute Type Description
object Required
The object always implements the ISLoadMessagesParams interface

Return Value

int

Example

Display the number of messages loaded on the basis of the selected filter and the information about them.

Dim aProvider
Dim aFilter
Dim aMessages
Dim aMessage
Dim aInfo
Dim i

Set aProvider = Profile.LoadProvider("ADMIN")
set aFilter = Profile.CreateLoadMessagesParams(aProvider.Id)

aFilter.StartIndex = 0
aFilter.CountOnPage = 10

aPageNumber = 1
do
  aInfo = aInfo  & vbNewLine & vbNewLine & "------- Page " & aPageNumber & " ----------" & vbNewLine 
  aPageNumber = aPageNumber + 1

  set aMessages = Profile.LoadMessages(aFilter)
  for i = 0 to aMessages.Count - 1  
    set aMessage = aMessages.Item(i)
    aInfo = aInfo & vbNewLine & (i + 1) & ") The message was sent by " & aMessage.Sender & " on " & aMessage.Sent      
  next
  aFilter.StartIndex = aFilter.StartIndex + aFilter.CountOnPage
loop while aFilter.CountOnPage = aMessages.Count

Profile.MsgBox(aInfo)
Note:

Version information

Added in v7.8.0