Change Search Index (CHGSCHIDX)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Change Search Index (CHGSCHIDX) command changes a search index. A search index is used to refer to the online help information contained in one or more panel groups. You can access online help information from user interface manager (UIM) panels, through data description specifications (DDS) by pressing the HELP key, or through the index search function.

Restrictions:

Top

Parameters

Keyword Description Choices Notes
SCHIDX Search index Qualified object name Required, Key, Positional 1
Qualifier 1: Search index Name
Qualifier 2: Library Name, *LIBL, *CURLIB
TITLE Display title Character value, *SAME Optional, Positional 2
TEXT Text 'description' Character value, *SAME, *BLANK, *TITLE Optional
CHRID Character identifier Single values: *SAME, *SYSVAL
Other values: Element list
Optional
Element 1: Graphic character set Integer
Element 2: Code page Integer
Top

Search index (SCHIDX)

Specifies the search index to be changed.

This is a required parameter.

Qualifier 1: Search index

name
Specify the name of the search index to be changed.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the search index. If no library is specified as the current library for the job, QGPL is used.
name
Specify the name of the library where the search index is located.
Top

Display title (TITLE)

Specifies the title you want to appear at the top of the display on which the search information is presented.

*SAME
The title does not change.
character-value
Specify no more than 55 characters of text, enclosed in apostrophes.
Top

Text 'description' (TEXT)

Specifies the text that briefly describes the object.

*SAME
The text does not change.
*TITLE
The first 50 characters of the title is used as the title for the search index.
*BLANK
No text is specified.
character-value
Specify no more than 50 characters of text, enclosed in apostrophes.
Top

Character identifier (CHRID)

Specifies the graphic character set and code page values used for the search index. The value specified for this parameter must match the TXTCHRID parameter value of panel groups added to this search index.

Single values

*SAME
The character set and code page values do not change.
*SYSVAL
The system determines the graphic character set and code page values for the command parameters from the QCHRID system value.

Element 1: Graphic character set

integer
Specify the graphic character set value that matches the character set of the synonyms used in the search index.

Element 2: Code page

integer
Specify the code page value that matches the code page of the synonyms used in the search index.
Top

Examples

CHGSCHIDX   SCHIDX(ACCOUNTING)  TITLE('Accounting Help Index')
            TEXT('Accounting Help Index')

This command changes the search index ACCOUNTING in the current library.

Top

Error messages

*ESCAPE Messages

CPF6E38
Character set and code page cannot be changed.
Top