LSE$CLIHELP.HLB  —  SUBSTITUTE
    Replaces occurrences of one text string with another.

    Format

      SUBSTITUTE   search-string

                   replace-string

1  –  Qualifiers

1.1    /ALL

    Specifies that all occurrences of the search string are to be
    replaced with the replace string. Specifying the /ALL qualifier
    causes LSE to perform all the indicated substitutions without
    prompting you for further instructions.

1.2    /CASE_MATCHING

       /CASE_MATCHING
       /NOCASE_MATCHING (D)

    Specifies whether LSE uses the case of words in the search
    string to determine the case for the replacement string. The
    four conditions are: uppercase, lowercase, capitalized, or
    undetermined. For example, if a word in the search string is
    all uppercase, all the letters of the corresponding word in the
    replacement string become uppercase. If a word in the search
    string does not match the criteria for uppercase, lowercase,
    or capitalization, or there are no alphabetic characters in
    the search string word, its case is undetermined and LSE does
    not modify the case of the corresponding word in the replacement
    string.

    If the replacement string contains more than one word, LSE
    respectively matches the case of words in the replacement string
    with the case of the corresponding words in the search string.
    If the search string contains fewer words than the replacement
    string, LSE matches the case of the additional words of the
    replacement string with the case of the last word in the search
    string.

    Specifying the /NOCASE_MATCHING qualifier causes LSE not to modify
    the case of the replacement string to match that of the search
    string.

1.3    /CONFIRM

       /CONFIRM (D)

    Instructs LSE to prompt you for a confirmation at each occurrence
    before performing a substitution. If you specify the /CONFIRM
    qualifier, LSE highlights each occurrence of the search string
    located by the search and prompts you for an action.

    o  YES instructs LSE to replace this occurrence.

    o  NO instructs LSE not to replace this occurrence but to proceed
       with the command.

    o  QUIT ends the command without replacing this occurrence and
       stops the SUBSTITUTE operation.

    o  ALL replaces this occurrence and all remaining occurrences
       without further prompting.

1.4    /DIALOG

       /DIALOG
       /NODIALOG (D)

    Instructs LSE to use a dialog box to prompt you for parameters
    and qualifier values. If you specify this qualifier, the command
    parameters are optional. If you supply command parameters and
    qualifiers with the /DIALOG qualifier, LSE uses those parameters
    and qualifiers to set the initial state of the dialog box.

    The Substitute dialog box has the same fields as the Search dialog
    box, plus a button for case-matching replacement and a text field
    for the replacement string.

1.5    /PATTERN

       /PATTERN
       /NOPATTERN (D)

    Enables or disables special interpretation of wildcard patterns
    in a search string. Use the SET SEARCH command to specify the
    style of wildcard patterns (VMS, ULTRIX or TPU).

    For details of the pattern styles use the command HELP FEATURES
    PATTERNS.

    When you specify the /NOPATTERN qualifier (or when it is the
    default), special interpretation of wildcard patterns in the
    search string is disabled.

1.6    /SINGLE

    Specifies that only one occurrence of the search string is to
    be replaced with the replacement string. Specifying the /SINGLE
    qualifier causes LSE to perform a single substitution without
    prompting you for an action.

2  –  Parameters

 search-string
    Specifies the string for which to search.

    If the TPU pattern style is being used the search-string is a
    TPU expression which must evaluate to a TPU pattern (for
    example: "'abc' | 'def'").

 replace-string
    Specifies the string to substitute.

    If the TPU pattern style is being used the replace-string is a
    TPU expression which must evaluate to a TPU string (for
    example: "'ghi'").
Close Help