getTypeDocumentation: Documentation for Type Element

In omegahat/SWinTypeLibs: Type Library Information Reader

Documentation for Type Element

Description

This retrieves the documentation for the specified entry in the type library (ITypeLib) or ITypeInfo object.

Usage

getTypeDocumentation(lib, which)

Arguments

lib	the ITypeLib or ITypeInfo object in which to find the documentation element.
which	the index of the entry (1-based) in the type library whose documentation is to be retrieved. If lib is an instance of ITypeInfo-class, a value of 0 gives the human-readable name of the type. Values 1, 2, ... give the names of the methods/property accessors.

Value

A character vector of length 3 giving the

DocString	the documentation string for this element.
Help Context	documentation for the context of this element.
Help File	the name of the help file.

Author(s)

Duncan Temple Lang <[e-mail]>

References

http://msdn.microsoft.com/library http://www.omegahat.org/RWinTypeLibs

See Also

LoadTypeLib getTypeInfo getTypeLibTypes

Examples

if(file.exists("c:\\WINNT\\system32\\wmpui.dll")) {
  l = LoadTypeLib("c:\\WINNT\\system32\\wmpui.dll")

  getTypeDocumentation(l, 0)

  getTypeDocumentation(l, 14)


  m <- matrix("", length(l), 3)
  for(i in 1:length(l)) {
   m[i, ] <- getTypeDocumentation(l, i)
  }
  print(m)

  w = COMCreate("Word.Application", existing = TRUE)
  lib = LoadTypeLib(w)
  getTypeDocumentation(lib[["Documents"]], 0)
  getTypeDocumentation(lib[["Documents"]], 1)
  lib = NULL
}

omegahat/SWinTypeLibs documentation built on Jan. 17, 2024, 6:40 p.m.