1 :Info: hyphenate_word_:  2020-04-25  hyphenate_word_
 2 
 3 hyphenate_word_ uses dictionary information to determine how to
 4 hyphenate a word which is too long to fit on a line of text.
 5 
 6 
 7 Entry points in hyphenate_word_:
 8    (List is generated by the help command)
 9 
10 
11 :Entry: hyphenate_word_:  07/23/84  hyphenate_word_
12 
13 
14 Function:  The hyphenate_word_ subroutine returns the character
15 position at which a word can be hyphenated.  The word is located in a
16 dictionary via the dict search list.
17 
18 
19 Syntax:
20 declare hyphenate_word_ entry (char(*), fixed bin,
21   fixed bin, fixed bin(35));
22 call hyphenate_word_ (string, space, break, code);
23 
24 declare hyphenate_word_ entry (char(*), fixed bin, fixed bin);
25 call hyphenate_word_ (string, space, break);
26 
27 
28 Arguments:
29 string (input)
30    the text word that is to be split.
31 space (input)
32    the number of print positions remaining in the line.
33 break (output)
34    the number of characters from the word that should be placed on the
35    current line; it should be at least one less than the value of space
36    (to allow for the hyphen), and can be 0 to specify that the word is
37    not to be broken.  Thus if the word "calling" is to be split, and
38    six spaces remain in the line, the procedure should return the value
39    4 (adjustment is performed after hyphenation).
40 
41 
42 code (output)
43    a standard status code.  In order to retain compatibility with an
44    older version of this subroutine, this argument is optional,
45    depending upon how hyphenate_word_ is declared in the calling
46    program.  If this subroutine is called with only three arguments,
47    then no code is returned.
48 
49 
50 :hcom:
51 
52 
53 
54 /****^  HISTORY COMMENTS:
55   1) change(2020-04-25,GDixon), approve(2021-02-22,MCR10088),
56      audit(2021-05-27,Swenson), install(2021-05-27,MR12.6g-0056):
57       A) Reformat using the newest subroutine info segment format.
58                                                    END HISTORY COMMENTS */
59 
60 
61