ISLibrary.GetDocuments

Description

This function returns the documents stored in the library.

Syntax

object.GetDocuments()

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

Return Value

ISCollection

Returns the documents stored in the library.

Example

Display some information about the library, including the list of its documents.

sub main
  Dim aLibrary
  Dim aMessage
    
  Set aLibrary = Profile.LoadRootLibrary
  aMessage = GetLibraryInfo(aLibrary, 0) 
  Profile.MsgBox (aMessage)    
end sub
     
function GetLibraryInfo(aLibrary, aLevel)
  Dim aDocs, aDoc
  Dim aInfo
  Dim i 
   
  set aDocs = aLibrary.GetDocuments 
  aInfo = Space(4 * aLevel) & aLibrary.Name &_
    "  library include " & aDocs.Count & " document(s): " & vbNewLine
  for i = 0 to aDocs.Count - 1
    set aDoc = aDocs.Item(i)
    aInfo = aInfo & Space(4 * aLevel) & (i + 1) & ") " &_
      aDoc.Name & vbNewLine 
  next     
     
  for i = 0 to aLibrary.Count - 1
    aInfo = aInfo & GetLibraryInfo(aLibrary.SubLibrary(i), aLevel + 1)  
  next
  
  GetLibraryInfo = aInfo
end function
Note:

In Profile Client v8 on User Interface Library Documents can be found in Maintain > Library > Document list.

Version information

Added in v7.8.0