3.4.6 - Get Help File Information

Action Option -GH (-GetHelpFile) :

retrieves Help file records (Documents and Software) from GDEXDB for the specified dataset, optionally filtered by file name.

dsarch [-(DS|Dataset)] dNNNNNN -(GH|GetHelpFile) [Mode Options]

[-(FN|FieldNames) FieldNameString]

[-(ON|OrderNames) OrderNameString]

[-(OB|OrderBy) OrderByPattern]

[-(HF|HelpFile) HelpFileNames]

[-(HT|HelpFileType) HelpFileTypes]

[-(FS|FileStatus) SavedFileStatus]

[-(FF|FileFlag) FilesOrPaths]

[-(LC|Location) StorageLocationFlags]

[-(SR|Source) ContributionSource]

[-(DE|Description) SavedFileDescriptions]

[-(OF|OutputFile) OutputFileName]

[-(DB|Debug) DebugModeInfo]

Available mode option:

-(FO|FormatOutput)

formats each column to a uniform fixed width

Use -FN (-FieldNames) to specify which Help file fields to retrieve. Defaults to ‘FINMTHSU’. Use -FN ALL for all available fields.

Valid Help file field names and their corresponding Info options:

Names	Info Options	Descriptions
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
P	-(FF|FileFlag)	File type flag, File or Path
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

A dataset number is required unless Help file names are provided. If file names match multiple datasets and no dataset number is given, an error prompts the specialist to specify one and rerun.

Results can be filtered by type (-HT) and description (-DE). Both -HF and -DE accept the ‘%’ wildcard.

Back to Top

Back to Table of Contents