ISLetter.VersionOnDate

Description

This function returns the version of the letter on the specified date.

Syntax

object.VersionOnDate(aDate)

Part Attribute Type Description
object Required
The object always implements the ISLetter interface
aDate In, Required
DateTime
The date of the returned version

Return Value

ISLetterVers

Returns the version of the letter on the specified date.

Example

Display the most recent version of the letter and the version on the specified date.

sub main()
  Dim aPatient
  Dim aLetters
  Dim aDate
  Dim aMessage

  Set aPatient = Profile.SelectPatient
  set aLetters = aPatient.GetLetters (1) ' slcfWordRTF

  aDate = #09/10/2019#
  aMessage = GetLetterInfo(aLetters, aDate)

  Profile.MsgBox(aMessage)
end sub


function GetLetterInfo(aLetters, aDate)
  Dim aInfo
  Dim aLetter
  Dim aLetterOnDate
  
  aInfo = "The number of the letters is " & aLetters.Count & vbNewLine
  
  for i = 0 to aLetters.Count - 1
    set aLetter = aLetters.Item(i)
    aInfo = aInfo & vbNewLine & "CURRENT LETTER VERSION: " & vbNewLine &_
      "   Subject: " & aLetter.Subject2 & vbNewLine &_
      "   ID: " & aLetter.ID & vbNewLine &_
      "   Date: " & aLetter.Date & vbNewLine &_
      "LETTER VERSION ON DATE:  " & vbNewLine    
    
    set aLetterOnDate = aLetter.VersionOnDate (aDate)
    if aLetterOnDate is nothing then    
      aInfo = aInfo & "   None" & vbNewLine 
    else            
      aInfo = aInfo &_
        "   Subject: " & aLetterOnDate.Subject2 & vbNewLine &_
        "   ID: " & aLetterOnDate.ID & vbNewLine &_
        "   Date: " & aLetterOnDate.Date & vbNewLine 
    end if 
  next 'i   
  GetLetterInfo = aInfo
end function 
Note:

In Profile Client v8 on User Interface Version On Date can be found in Report > Find Objects > Letters > Letter Version.

Version information

Added in v7.8.0