ISLibrary.GetSubLibraryByName

Description

This function returns the sub-library by its name.

Syntax

object.GetSubLibraryByName(aName)

Part Attribute Type Description
object Required
The object always implements the ISLibrary interface
aName In, Required
string
The name of the sub-library

Return Value

ISLibrary

Returns the sub-library with the specified name.

Example

Display some information about the documents from the library with the specified name.

sub main
  Dim aLibName
  Dim aLibrary
  Dim aSubLib
  
  aLibName = InputBox("Enter the name of the library category:")
  'for example, "Patient information"
  if aLibName = "" then exit sub
    
  Set aLibrary = Profile.LoadRootLibrary
  set aSubLib = aLibrary.GetSubLibraryByName(aLibName)
  
  if aSubLib is nothing then
    Profile.MsgBox("The library with the specified name does not exist")
    exit sub
  else
    Dim aDocs, aDoc 
    Dim aInfo
    Dim i
     
    set aDocs = aSubLib.GetDocuments  
  
    aInfo = aSubLib.Name & " category has " & aDocs.Count & " documents: " & vbNewLine 
    
    for i = 0 to aDocs.Count - 1
      set aDoc = aDocs.Item(i)
      aInfo = aInfo & (i + 1) & ") " &_
        aDoc.Name & vbNewLine & vbNewLine &_
        "    The type of the document: " & aDoc.TypeDescription & vbNewLine &_ 
        "    The type code of the document: " & aDoc.TypeCode & vbNewLine & vbNewLine
    next     
    Profile.MsgBox(aInfo)  
  end if                       
    
end sub
Note:

In Profile Client v8 on User Interface Library cannot be found, but Library can be found in Maintain > Library.

Version information

Added in v7.10.60