Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

 ◄Key► ◄Summary►                             ◄Up► ◄Contents► ◄Index► ◄Back►
────────────────────────────────────────────────────────────────────────────
 
  Description:
 
     In each message file, messages are divided into sets; this enables
     you to define your own message set in the default message file if
     you wish. This routine also enables you to insert portions of text
     into a message fetched from the message file in the order appropriate
     to the rules of the grammar for the national language.
 
  Parameters on Entry:
 
     msg-file-handle         The identifying handle of the message file
                             to fetch the message from.
 
     msg-set-number          The set in the message file to fetch the
                             message from.
 
     msg-number              The message number in the message set to fetch
                             the message from.
 
     insertion-count         The number of portions of text to insert in to
                             the message.
 
     insertion-pointer       A pointer to a null-terminated portion of text
                             to insert in to the message.
 
     msg-buffer-length       The length of msg-buffer-text.
 
  Parameters on Exit:
 
     msg-buffer-text         The returned text (null-terminated).
 
     status-code             Indicates whether the routine was successful:
 
                               0 = Success
                              40 = NLS module not initialized
                             401 = Message set not found
                             402 = Message not found in set
                             403 = Message too long for message-text-buffer
                             404 = Invalid message-file-handle
 
                             If status-code contains a value other than
                             these, it will be the number of a run-time
                             error message.
 
     This routine can be used only from a program that was compiled with
     the NLS directive. For more details on National Language Support see
     the chapter National Language Support in your COBOL System Reference.
 
     See also ◄NLS directive►
                                    -♦-