3.4.6 - Get Help File Information

      Action Option -GH (-GetHelpFile) :

      gets information of Help files, Documents and Softwares, for a given dataset and/or specified Help file names. The file list can be further specified for given file types, and other conditions.

      dsarch[-(DS|Dataset)] dsnnn.n -(GH|GetHelpFile) [Mode Options]
        [-(FN|FieldNames) FieldNameString]
        [-(ON|OrderNames) OrderNameString]
        [-(OB|OrderBy) OrderByPattern]
        [-(HF|HelpFile) HelpFileNames]
        [-(HT|HelpFileType) HelpFileTypes]
        [-(FS|FileStatus) SavedFileStatus]
        [-(LC|Location) StorageLocationFlags]
        [-(SR|Source) ContributionSource]
        [-(DE|Description) SavedFileDescriptions]
        [(-OF|-OutputFile) OutputFileName]
        [-(DB|Debug) DebugModeInfo]

      Mode option that can be specified for getting Help file action:

      Use Info option -FN (-FieldNames) to specify what fields of Help files to retrieve. It defaults to 'FINMTHSU' if option -FN is not provided; information of all available fields is retrieved if -FN ALL is given.

      Valid Saved file field names and their corresponding Info options:

      -(FO|FormatOutput)format the column output with a same width for all values of a given field
      NamesInfo OptionsDescriptions
      F-(HF|HelpFile)Help file names
      N-(DF|DataFormat)file content formats
      M-(AF|ArchiveFormat)file archive formats
      O-(DO|DisplayOrder)display order indices
      T-(HT|HelpFileType)Help file archiving types
      H-(FS|FileStatus)Help file archiving status
      L-(LC|Location)Help file storage location flag
      S-(SZ|Size)Help file sizes
      R-(SR|Source)Help file contribution source
      I-(ID|InitialDate)Date initially Published/Released
      J-(FD|FileDate)date last modified on
      K-(FT|FileTime)time last modified at
      U-(WU|WebURL'a full URL for a remote help file
      D-(DE|Description)file descriptions

      The dataset number per option -DS (-Dataset) is mandatory unless Help file names are provided. An error message is prompted for specialist to pick one dataset number and rerun 'dsarch' if multiple datasets are identified for given Help file information without specified dataset number.

      Help file information can be retrieved for further specified file archive types per option -HT (-HelpFileType), and file descriptions per -DE (-Description). Info options -HF and -DE accept wildcard inputs of '%' for matching any number of characters.



      Back to Top