{"version":"c6d68b0","count":2190,"topics":[{"slug":"access/access-query-language","title":"Access Query Language","category":"ACCESS / AQL","categorySlug":"access","summary":"The Access Query Language (AQL) is a D3 facility used to retrieve and output data. It is an original component of the D3 system and consists of the List pre-processor, the Select processor, and the Output processor. AQL is a system-level information retrieval language that allows users to query their database without writing complex programs.","url":"https://d3codex.com/access/access-query-language/","api":"https://d3codex.com/api/topics/access/access-query-language.json"},{"slug":"access/access-query-language-overview","title":"Access Query Language overview","category":"ACCESS / AQL","categorySlug":"access","summary":"AQL uses TCL commands and displays the results either on terminals or printers. AQL operates on specified files and items based on various optional criteria, specifications, modifiers, limiters, and options.","url":"https://d3codex.com/access/access-query-language-overview/","api":"https://d3codex.com/api/topics/access/access-query-language-overview.json"},{"slug":"access/after-operator","title":"after operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The after relational operator represents a greater than condition used in constructing selection clauses. The gt and > operators perform the same function.","url":"https://d3codex.com/access/after-operator/","api":"https://d3codex.com/api/topics/access/after-operator.json"},{"slug":"access/and-clause","title":"and clause","category":"ACCESS / AQL","categorySlug":"access","summary":"The and clause is used between selection criteria clauses to indicate that both condition being evaluated as true selects the item for processing.","url":"https://d3codex.com/access/and-clause/","api":"https://d3codex.com/api/topics/access/and-clause.json"},{"slug":"access/any-modifier","title":"any modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The any modifier searches an entire item for a match, all attributes and all values. Each value is compared to the selection criteria and if the value passes the criteria, then the item is selected for further processing. This feature is useful for searching nonattribute-oriented files for specific words or phrases, such as word processor documents, source programs, and so on.","url":"https://d3codex.com/access/any-modifier/","api":"https://d3codex.com/api/topics/access/any-modifier.json"},{"slug":"access/aql-command-categories","title":"AQL command categories","category":"ACCESS / AQL","categorySlug":"access","summary":"AQL commands essentially break down into these categories:","url":"https://d3codex.com/access/aql-command-categories/","api":"https://d3codex.com/api/topics/access/aql-command-categories.json"},{"slug":"access/aql-commands","title":"AQL commands","category":"ACCESS / AQL","categorySlug":"access","summary":"The following AQL commands are available.","url":"https://d3codex.com/access/aql-commands/","api":"https://d3codex.com/api/topics/access/aql-commands.json"},{"slug":"access/aql-modifiers","title":"AQL modifiers","category":"ACCESS / AQL","categorySlug":"access","summary":"The following AQL modifiers are available.","url":"https://d3codex.com/access/aql-modifiers/","api":"https://d3codex.com/api/topics/access/aql-modifiers.json"},{"slug":"access/aql-relational-operators-and-logical-clauses","title":"AQL relational operators and logical clauses","category":"ACCESS / AQL","categorySlug":"access","summary":"This section presents information for each of the AQL relational operators and logical clauses.","url":"https://d3codex.com/access/aql-relational-operators-and-logical-clauses/","api":"https://d3codex.com/api/topics/access/aql-relational-operators-and-logical-clauses.json"},{"slug":"access/aql-sentence-form","title":"AQL sentence form","category":"ACCESS / AQL","categorySlug":"access","summary":"In an AQL sentence, the command and file reference are required. The AQL command must be the first word of the sentence. All other elements are optional and are used to modify either the operator, operand, or output.","url":"https://d3codex.com/access/aql-sentence-form/","api":"https://d3codex.com/api/topics/access/aql-sentence-form.json"},{"slug":"access/aql-user-exits","title":"AQL user exits","category":"ACCESS / AQL","categorySlug":"access","summary":"User exits allow direct access to system functions.","url":"https://d3codex.com/access/aql-user-exits/","api":"https://d3codex.com/api/topics/access/aql-user-exits.json"},{"slug":"access/before-operator","title":"before operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The before relational operator represents a less than condition used in constructing selection clauses. The < and lt operators perform the same function as before.","url":"https://d3codex.com/access/before-operator/","api":"https://d3codex.com/api/topics/access/before-operator.json"},{"slug":"access/break-on-modifier","title":"break-on modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The break-on modifier creates a visual break in output data when the value in the current output field is different from the previous value. The break-on modifier groups items in a listing according to the value of the break-on attribute name. The attribute name indicates the attribute on which a break occurs.","url":"https://d3codex.com/access/break-on-modifier/","api":"https://d3codex.com/api/topics/access/break-on-modifier.json"},{"slug":"access/by-dsnd-modifier","title":"by-dsnd modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The by-dsnd modifier designates a sort key, in descending order and must be followed by an attribute name. It may be used with any command that lists or selects items, such as list or select.","url":"https://d3codex.com/access/by-dsnd-modifier/","api":"https://d3codex.com/api/topics/access/by-dsnd-modifier.json"},{"slug":"access/by-exp-dsnd-modifier","title":"by-exp-dsnd modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The -by-exp-dsnd modifier is followed by an attribute name that references a MultiValue attribute to be used individually as sort keys in descending order.","url":"https://d3codex.com/access/by-exp-dsnd-modifier/","api":"https://d3codex.com/api/topics/access/by-exp-dsnd-modifier.json"},{"slug":"access/by-exp-modifier","title":"by-exp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The by-exp modifier designates a sort key, in ascending, exploded MultiValue order and must be followed by an attribute name. It may be used with any command that lists or selects items, such as list or select.","url":"https://d3codex.com/access/by-exp-modifier/","api":"https://d3codex.com/api/topics/access/by-exp-modifier.json"},{"slug":"access/by-modifier","title":"by modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The by modifier designates a sort key, in ascending order, and must be followed by an attr.name. It may be used with any command that lists or selects items, such as list or select.","url":"https://d3codex.com/access/by-modifier/","api":"https://d3codex.com/api/topics/access/by-modifier.json"},{"slug":"access/check-sum-command","title":"check-sum command","category":"ACCESS / AQL","categorySlug":"access","summary":"The check-sum command calculates a hexadecimal checksum for a specified attribute, or the entire item if no attribute is specified, and produces result as a list. The checksum statistics change whenever a file is updated, providing a means to determine if a file has been changed.","url":"https://d3codex.com/access/check-sum-command/","api":"https://d3codex.com/api/topics/access/check-sum-command.json"},{"slug":"access/col-hdr-supp-modifier","title":"col-hdr-supp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The col-hdr-supp modifier suppresses column heading above output columns and default page heading on AQL reports.","url":"https://d3codex.com/access/col-hdr-supp-modifier/","api":"https://d3codex.com/api/topics/access/col-hdr-supp-modifier.json"},{"slug":"access/conv-modifier","title":"conv modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The conv modifier substitutes the conversion codes specified in conversion for attribute 7 of the specified Attribute-Defining-Item.","url":"https://d3codex.com/access/conv-modifier/","api":"https://d3codex.com/api/topics/access/conv-modifier.json"},{"slug":"access/converting-nulls-modifier","title":"converting-nulls modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The converting-nulls modifier allows all values (including nulls) to be processed by the output-conversion. Normally, null values are not processed by the output-conversion so that they do not unnecessarily take up space on a report. However, some output-conversions, such as those that call FlashBASIC subroutines, may need to see each and every value, even if it is null.","url":"https://d3codex.com/access/converting-nulls-modifier/","api":"https://d3codex.com/api/topics/access/converting-nulls-modifier.json"},{"slug":"access/count-command","title":"count command","category":"ACCESS / AQL","categorySlug":"access","summary":"The count command produces a total of the number of items that meet the selection criteria as determined by the item.list and selection.criteria specification.","url":"https://d3codex.com/access/count-command/","api":"https://d3codex.com/api/topics/access/count-command.json"},{"slug":"access/dbl-spc-modifier","title":"dbl-spc modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The dbl-spc modifier double-spaces output by inserting a blank line between items.","url":"https://d3codex.com/access/dbl-spc-modifier/","api":"https://d3codex.com/api/topics/access/dbl-spc-modifier.json"},{"slug":"access/default-attribute-items-access-query-language","title":"Default attribute items (Access Query Language)","category":"ACCESS / AQL","categorySlug":"access","summary":"Default attribute items have numeric item-IDs starting with 1.","url":"https://d3codex.com/access/default-attribute-items-access-query-language/","api":"https://d3codex.com/api/topics/access/default-attribute-items-access-query-language.json"},{"slug":"access/default-output-specifications","title":"Default output specifications","category":"ACCESS / AQL","categorySlug":"access","summary":"In addition to explicitly listing attribute names as part of the AQL sentence, there are three features that can be used to specify default output specifications.","url":"https://d3codex.com/access/default-output-specifications/","api":"https://d3codex.com/api/topics/access/default-output-specifications.json"},{"slug":"access/det-supp-modifier","title":"det-supp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The det-supp modifier suppresses the detail lines in a report. It provides the ability to easily fold detailed information into summary reports and is typically used in conjunction with the total, break-on, and roll-on AQL modifiers.","url":"https://d3codex.com/access/det-supp-modifier/","api":"https://d3codex.com/api/topics/access/det-supp-modifier.json"},{"slug":"access/dict-modifier","title":"dict modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The dict modifier is used immediately preceding a file name and affects the dictionary level of the specified file rather than the data section.","url":"https://d3codex.com/access/dict-modifier/","api":"https://d3codex.com/api/topics/access/dict-modifier.json"},{"slug":"access/equal-operator","title":"equal operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The equal operator represents an equal to condition used in constructing selection clauses. When a valuestring is included, the data found in each item must match it exactly in order for the data to be selected for processing.","url":"https://d3codex.com/access/equal-operator/","api":"https://d3codex.com/api/topics/access/equal-operator.json"},{"slug":"access/eval-modifier","title":"eval modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The eval modifier performs the operation specified in the expression on the specified Attribute-Defining-Items. The expression performed is limited to A-Correlatives (concatenation, addition, subtraction, multiplication and division (:, +, -, *, /)).","url":"https://d3codex.com/access/eval-modifier/","api":"https://d3codex.com/api/topics/access/eval-modifier.json"},{"slug":"access/every-modifier","title":"every modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The every modifier forces comparison on every value, rather than any value.","url":"https://d3codex.com/access/every-modifier/","api":"https://d3codex.com/api/topics/access/every-modifier.json"},{"slug":"access/file-reference-access-query-language","title":"File reference (Access Query Language)","category":"ACCESS / AQL","categorySlug":"access","summary":"A file reference is a standardized mechanism for designating a particular file within D3.","url":"https://d3codex.com/access/file-reference-access-query-language/","api":"https://d3codex.com/api/topics/access/file-reference-access-query-language.json"},{"slug":"access/fill-modifier","title":"fill modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The fill modifier forces listings into an across-the-page format if the listing would otherwise be noncolumnar. The headings and values are printed one after another across the page. This has no effect on columnar listings. The equivalent option is r.","url":"https://d3codex.com/access/fill-modifier/","api":"https://d3codex.com/api/topics/access/fill-modifier.json"},{"slug":"access/fmt-modifier","title":"fmt modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The fmt modifier substitutes the column heading, justification and width settings specified in \"{&#39;<column-heading>&#39;} {<just>} {<width>}\" for attributes 3, 9 and 10 of the specified Attribute-Defining-Item.","url":"https://d3codex.com/access/fmt-modifier/","api":"https://d3codex.com/api/topics/access/fmt-modifier.json"},{"slug":"access/footing-modifier","title":"footing modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The footing modifier designates a text string composed of literals and special options to output at the bottom of each page.","url":"https://d3codex.com/access/footing-modifier/","api":"https://d3codex.com/api/topics/access/footing-modifier.json"},{"slug":"access/ge-operator","title":"ge operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The ge relational operator represents a greater than or equal to condition used in constructing selection clauses.","url":"https://d3codex.com/access/ge-operator/","api":"https://d3codex.com/api/topics/access/ge-operator.json"},{"slug":"access/grand-total-modifier","title":"grand-total modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The grand-total modifier substitutes a string of text in place of the standard \"***\" literal string normally output on the grand total line. This produces a grand total only in sentences that include the total modifier. Multiple options may be enclosed in the same set of single quotation marks.","url":"https://d3codex.com/access/grand-total-modifier/","api":"https://d3codex.com/api/topics/access/grand-total-modifier.json"},{"slug":"access/gt-operator","title":"gt operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The gt operator is a greater than relational operator.","url":"https://d3codex.com/access/gt-operator/","api":"https://d3codex.com/api/topics/access/gt-operator.json"},{"slug":"access/hash-test-command","title":"hash-test command","category":"ACCESS / AQL","categorySlug":"access","summary":"The hash-test command produces a histogram, or graphic representation of item-ID distribution within a given file, according to a test modulo provided. The command is useful when performing file reallocation, providing insight into how the item-IDs hash into the file, as well as providing a suggested modulo.","url":"https://d3codex.com/access/hash-test-command/","api":"https://d3codex.com/api/topics/access/hash-test-command.json"},{"slug":"access/hdr-supp-modifier","title":"hdr-supp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The hdr-supp modifier suppresses the default page heading (system time/date and page number) on output.","url":"https://d3codex.com/access/hdr-supp-modifier/","api":"https://d3codex.com/api/topics/access/hdr-supp-modifier.json"},{"slug":"access/heading-modifier","title":"heading modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The heading modifier designates a text string composed of literals and special options to output at the top of each page.","url":"https://d3codex.com/access/heading-modifier/","api":"https://d3codex.com/api/topics/access/heading-modifier.json"},{"slug":"access/id-supp-modifier","title":"id-supp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The id-supp modifier suppresses the automatic display of item-IDs in the leftmost column of an AQL report.","url":"https://d3codex.com/access/id-supp-modifier/","api":"https://d3codex.com/api/topics/access/id-supp-modifier.json"},{"slug":"access/ifno-modifier","title":"ifno modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The ifno modifier is the same as indicating with no or with not in an AQL sentence.","url":"https://d3codex.com/access/ifno-modifier/","api":"https://d3codex.com/api/topics/access/ifno-modifier.json"},{"slug":"access/index-utilization-in-selection-criteria","title":"Index utilization in selection criteria","category":"ACCESS / AQL","categorySlug":"access","summary":"Indexes can be used with the following types of selection criteria:","url":"https://d3codex.com/access/index-utilization-in-selection-criteria/","api":"https://d3codex.com/api/topics/access/index-utilization-in-selection-criteria.json"},{"slug":"access/istat-command","title":"istat command","category":"ACCESS / AQL","categorySlug":"access","summary":"The istat command produces a graphic representation of item-ID distribution within a file and suggests a new modulo. The istat command is equivalent to the hash-test command.","url":"https://d3codex.com/access/istat-command/","api":"https://d3codex.com/api/topics/access/istat-command.json"},{"slug":"access/item-list","title":"Item list","category":"ACCESS / AQL","categorySlug":"access","summary":"The item list specifies one or more item-IDs in the file defined by the associated file reference.","url":"https://d3codex.com/access/item-list/","api":"https://d3codex.com/api/topics/access/item-list.json"},{"slug":"access/le-operator","title":"le operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The le operator selects items whose specified attribute name contains a value less than or equal to the specified value string.","url":"https://d3codex.com/access/le-operator/","api":"https://d3codex.com/api/topics/access/le-operator.json"},{"slug":"access/legend-supp-modifier","title":"legend-supp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The legend-supp modifier suppresses the output of the legend on list and sort operations directed to the spooler.","url":"https://d3codex.com/access/legend-supp-modifier/","api":"https://d3codex.com/api/topics/access/legend-supp-modifier.json"},{"slug":"access/list-command","title":"list command","category":"ACCESS / AQL","categorySlug":"access","summary":"The list command generates formatted output based upon the specified arguments. If an item list is specified, items are listed in order of the item-IDs in the item list. If an item list is not specified, items are listed by the groups into which they hash, and within each group, each item is listed in the order in which it was entered or most recently updated.","url":"https://d3codex.com/access/list-command/","api":"https://d3codex.com/api/topics/access/list-command.json"},{"slug":"access/list-item-command-access-query-language","title":"list-item command (Access Query Language)","category":"ACCESS / AQL","categorySlug":"access","summary":"The list-item command displays items in their internally stored format. The list-item command combines the action of the copy command with the selection criteria and format capabilities of the list command. The items are copied to the user’s terminal or to the printer just as the copy command would copy them, with the line numbers on the left margin.","url":"https://d3codex.com/access/list-item-command-access-query-language/","api":"https://d3codex.com/api/topics/access/list-item-command-access-query-language.json"},{"slug":"access/list-label-command","title":"list-label command","category":"ACCESS / AQL","categorySlug":"access","summary":"The list-label command produces one or more columns of output.","url":"https://d3codex.com/access/list-label-command/","api":"https://d3codex.com/api/topics/access/list-label-command.json"},{"slug":"access/locking-modifier","title":"locking modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The locking modifier locks an item for AQL report processing. The purpose of this modifier is to prevent transient GFEs when using the AQL list or select commands on large items that are being simultaneously updated by another user/process.","url":"https://d3codex.com/access/locking-modifier/","api":"https://d3codex.com/api/topics/access/locking-modifier.json"},{"slug":"access/lptr-modifier","title":"lptr modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The lptr modifier directs output of AQL sentences to the system printer, via the spooler. The output is directed according to the options most recently established with the sp-assign command. The AQL sentence that created the output is automatically listed at the top of the first page of output, unless otherwise suppressed with the tcl-supp modifier.","url":"https://d3codex.com/access/lptr-modifier/","api":"https://d3codex.com/api/topics/access/lptr-modifier.json"},{"slug":"access/lt-operator","title":"lt operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The lt operator selects items whose specified attribute name contains a value less than the specified value string.","url":"https://d3codex.com/access/lt-operator/","api":"https://d3codex.com/api/topics/access/lt-operator.json"},{"slug":"access/modifiers","title":"Modifiers","category":"ACCESS / AQL","categorySlug":"access","summary":"Modifiers control listing parameters such as double-spacing (dbl-spc), control breaks (roll-on or break-on), column totals (total), and suppression of item-IDs (id-supp), automatic headings (hdr-supp or col-hdr-supp), and default messages (ni-supp).","url":"https://d3codex.com/access/modifiers/","api":"https://d3codex.com/api/topics/access/modifiers.json"},{"slug":"access/ne-operator","title":"ne operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The ne operator selects items whose specified attribute name contains a value not equal to the specified value string.","url":"https://d3codex.com/access/ne-operator/","api":"https://d3codex.com/api/topics/access/ne-operator.json"},{"slug":"access/ni-supp-modifier","title":"ni-supp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The ni-supp modifier suppresses the number of items listed message at the end of most AQL reports.","url":"https://d3codex.com/access/ni-supp-modifier/","api":"https://d3codex.com/api/topics/access/ni-supp-modifier.json"},{"slug":"access/no-operator","title":"no operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The no operator reverses selection condition.","url":"https://d3codex.com/access/no-operator/","api":"https://d3codex.com/api/topics/access/no-operator.json"},{"slug":"access/nopage-modifier","title":"nopage modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The nopage modifier prevents terminal output from pausing at the end of each page. CTRL+X, which terminates a report when the report is paused at a page break, serves no purpose when a report is being produced in nopage mode. It does not stop the report. The only way to stop it is to press the BREAK key and end the process. The equivalent option is n.","url":"https://d3codex.com/access/nopage-modifier/","api":"https://d3codex.com/api/topics/access/nopage-modifier.json"},{"slug":"access/not-operator","title":"not operator","category":"ACCESS / AQL","categorySlug":"access","summary":"The not operator represents a not equal to condition. This reverses the true sense of the condition in a selection criteria. The #, no, and ne operators perform the same function as not.","url":"https://d3codex.com/access/not-operator/","api":"https://d3codex.com/api/topics/access/not-operator.json"},{"slug":"access/nselect-command","title":"nselect command","category":"ACCESS / AQL","categorySlug":"access","summary":"The nselect command selects items that would fail the selection criteria of a select. When an output list displays in any of the various select sentences, the list is built from the contents of the specified attribute.","url":"https://d3codex.com/access/nselect-command/","api":"https://d3codex.com/api/topics/access/nselect-command.json"},{"slug":"access/oconvs-function","title":"oconvs() function","category":"ACCESS / AQL","categorySlug":"access","summary":"See eval modifier for more information.","url":"https://d3codex.com/access/oconvs-function/","api":"https://d3codex.com/api/topics/access/oconvs-function.json"},{"slug":"access/only-modifier","title":"only modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The only modifier ignores default attribute-defining items and displays only the item-IDs from the given file reference. The only modifier must precede the file reference.","url":"https://d3codex.com/access/only-modifier/","api":"https://d3codex.com/api/topics/access/only-modifier.json"},{"slug":"access/options-access-query-language","title":"Options (Access Query Language)","category":"ACCESS / AQL","categorySlug":"access","summary":"Options are used to alter the behavior of AQL sentences.","url":"https://d3codex.com/access/options-access-query-language/","api":"https://d3codex.com/api/topics/access/options-access-query-language.json"},{"slug":"access/or-clause","title":"or clause","category":"ACCESS / AQL","categorySlug":"access","summary":"The or clause is used between selection criteria clauses to indicate that either condition being evaluated as true selects the item for processing.","url":"https://d3codex.com/access/or-clause/","api":"https://d3codex.com/api/topics/access/or-clause.json"},{"slug":"access/output-specifications","title":"Output specifications","category":"ACCESS / AQL","categorySlug":"access","summary":"Output specifications specify the attributes to list.","url":"https://d3codex.com/access/output-specifications/","api":"https://d3codex.com/api/topics/access/output-specifications.json"},{"slug":"access/phrases","title":"Phrases","category":"ACCESS / AQL","categorySlug":"access","summary":"Phrases must be defined in the dictionary of the file that the phrase is used (or in the account&#39;s master dictionary). Line one of the phrase definition must be an H. Line two of the phrase definition contains the words that make up the phrase.","url":"https://d3codex.com/access/phrases/","api":"https://d3codex.com/api/topics/access/phrases.json"},{"slug":"access/print-limiters","title":"Print limiters","category":"ACCESS / AQL","categorySlug":"access","summary":"Print limiters suppress the listing of attributes within an item that do not meet specified limits.","url":"https://d3codex.com/access/print-limiters/","api":"https://d3codex.com/api/topics/access/print-limiters.json"},{"slug":"access/quotation-marks","title":"Quotation marks","category":"ACCESS / AQL","categorySlug":"access","summary":"With the AQL pre-processor, quotation marks are not required to distinguish values from other parts of an AQL sentence. Any word that is not in the file dictionary or account master dictionary, is assumed to be a value, provided that it makes sense to use a value in that part of the sentence. If it does not make sense, then an error message is printed and the sentence is aborted.","url":"https://d3codex.com/access/quotation-marks/","api":"https://d3codex.com/api/topics/access/quotation-marks.json"},{"slug":"access/reformat-command","title":"reformat command","category":"ACCESS / AQL","categorySlug":"access","summary":"The reformat command takes values from the attributes specified in the command and places them either in another file or to tape in the order in which they are presented.","url":"https://d3codex.com/access/reformat-command/","api":"https://d3codex.com/api/topics/access/reformat-command.json"},{"slug":"access/relational-operators-and-logical-clauses","title":"Relational operators and logical clauses","category":"ACCESS / AQL","categorySlug":"access","summary":"Relational operators are modifiers used to establish criteria based on the relationship of data to fixed values or other data.","url":"https://d3codex.com/access/relational-operators-and-logical-clauses/","api":"https://d3codex.com/api/topics/access/relational-operators-and-logical-clauses.json"},{"slug":"access/require-select-command","title":"require.select command","category":"ACCESS / AQL","categorySlug":"access","summary":"The require.select command is used with any AQL sentence when you want to process a select list.","url":"https://d3codex.com/access/require-select-command/","api":"https://d3codex.com/api/topics/access/require-select-command.json"},{"slug":"access/retrieval-of-items-from-files","title":"Retrieval of items from files","category":"ACCESS / AQL","categorySlug":"access","summary":"The AQL processor uses both the master dictionary and the file dictionary to determine the definition of the elements in the AQL sentence. The pointer to the file dictionary and the connectives used in the sentence, for example, are found in the master dictionary. The file pointer to the data file and file-specific attribute definitions are found in the file dictionary.","url":"https://d3codex.com/access/retrieval-of-items-from-files/","api":"https://d3codex.com/api/topics/access/retrieval-of-items-from-files.json"},{"slug":"access/roll-on-modifier","title":"roll-on modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The roll-on modifier creates a visual break in output data when the value of a specified attribute changes; an improvement over the break-on command. The roll-on connective is similar to the break-on connective, but has several enhanced features.","url":"https://d3codex.com/access/roll-on-modifier/","api":"https://d3codex.com/api/topics/access/roll-on-modifier.json"},{"slug":"access/sampling-modifier","title":"sampling modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The sampling modifier limits the number of items processed by the AQL sentence to a specific number. If selection criteria are included within the sentence, processing continues until the specified number of items are found that match the selection criteria.","url":"https://d3codex.com/access/sampling-modifier/","api":"https://d3codex.com/api/topics/access/sampling-modifier.json"},{"slug":"access/select-command","title":"select command","category":"ACCESS / AQL","categorySlug":"access","summary":"The select command retrieves all items from the specified file reference that meet the optional selection criteria. The items are selected in the order of their appearance in the file reference. The selected item may be saved for future use or acted upon immediately.","url":"https://d3codex.com/access/select-command/","api":"https://d3codex.com/api/topics/access/select-command.json"},{"slug":"access/selection-criteria","title":"Selection criteria","category":"ACCESS / AQL","categorySlug":"access","summary":"Selection criteria determines which items are to be processed by AQL and is designated by the with or if modifiers. Without any selection clauses in an AQL sentence, every item in the file is eligible for processing.","url":"https://d3codex.com/access/selection-criteria/","api":"https://d3codex.com/api/topics/access/selection-criteria.json"},{"slug":"access/show-nulls-modifier","title":"show-nulls modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The show-nulls modifier allows the display of empty multivalues.","url":"https://d3codex.com/access/show-nulls-modifier/","api":"https://d3codex.com/api/topics/access/show-nulls-modifier.json"},{"slug":"access/sort-command","title":"sort command","category":"ACCESS / AQL","categorySlug":"access","summary":"The sort command generates sorted and formatted output of selected items and attributes from a specified file. The output produced by sort is identical to the output produced by list when the by modifier is specified. The default sort sequence can be altered by using the ms processing code (see ms (Mask Alter Sort) processing code for more information.","url":"https://d3codex.com/access/sort-command/","api":"https://d3codex.com/api/topics/access/sort-command.json"},{"slug":"access/sort-criteria","title":"Sort criteria","category":"ACCESS / AQL","categorySlug":"access","summary":"A sort criteria defines the AQL collation sequence. The sort is invoked by the by, by-dsnd, by-exp, or by-exp-dsnd modifiers in a left-to-right order to determine the order in which items are processed by AQL. There is no limit to the number of sort keys within an AQL sentence.","url":"https://d3codex.com/access/sort-criteria/","api":"https://d3codex.com/api/topics/access/sort-criteria.json"},{"slug":"access/sort-item-command","title":"sort-item command","category":"ACCESS / AQL","categorySlug":"access","summary":"The sort-item command displays items in their internally stored format, in order of the given sort-key. The sort-item command combines the action of the copy command with the selection criteria and format capabilities of the sort command.","url":"https://d3codex.com/access/sort-item-command/","api":"https://d3codex.com/api/topics/access/sort-item-command.json"},{"slug":"access/sort-label-command","title":"sort-label command","category":"ACCESS / AQL","categorySlug":"access","summary":"The sort-label command produces one or more columns of output in order of the specified sort-key. The sort-label command outputs formatted labels or reports in columnar format from the specified file reference, sequenced by one or more sort-key.","url":"https://d3codex.com/access/sort-label-command/","api":"https://d3codex.com/api/topics/access/sort-label-command.json"},{"slug":"access/sreformat-command","title":"sreformat command","category":"ACCESS / AQL","categorySlug":"access","summary":"The sreformat command moves the sorted values from the attributes specified in the AQL sentence and places them either in another file or to tape in the order of the specified sort key (specified in sort.criteria).","url":"https://d3codex.com/access/sreformat-command/","api":"https://d3codex.com/api/topics/access/sreformat-command.json"},{"slug":"access/ss-modifier","title":"ss modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The ss (spreadsheet) connective allows printing out AQL reports in spreadsheet format. This is achieved by adding the ss connective to a sort sentence and defining the desired range parameters.","url":"https://d3codex.com/access/ss-modifier/","api":"https://d3codex.com/api/topics/access/ss-modifier.json"},{"slug":"access/sselect-command","title":"sselect command","category":"ACCESS / AQL","categorySlug":"access","summary":"The sselect command creates a sorted list of items from the specified file reference that meet selection criteria.","url":"https://d3codex.com/access/sselect-command/","api":"https://d3codex.com/api/topics/access/sselect-command.json"},{"slug":"access/stat-command","title":"stat command","category":"ACCESS / AQL","categorySlug":"access","summary":"The stat command outputs the total number of items processed and an average value of all items that meet the specified selection criteria.","url":"https://d3codex.com/access/stat-command/","api":"https://d3codex.com/api/topics/access/stat-command.json"},{"slug":"access/string-searching","title":"String searching","category":"ACCESS / AQL","categorySlug":"access","summary":"AQL permits the use of string searching (sometimes called wildcards), that allows introducing variables into the selection criteria. Consider the sentence:","url":"https://d3codex.com/access/string-searching/","api":"https://d3codex.com/api/topics/access/string-searching.json"},{"slug":"access/sum-command","title":"sum command","category":"ACCESS / AQL","categorySlug":"access","summary":"The sum command produces a numeric total of a given attribute for all items meeting the optional selection criteria. If an attribute name (attribute name or number) is not specified, the total number of characters in the selected items are calculated. If only the file reference is specified, the total number of characters in the entire file is calculated, including attribute and value marks.","url":"https://d3codex.com/access/sum-command/","api":"https://d3codex.com/api/topics/access/sum-command.json"},{"slug":"access/tape-modifier","title":"tape modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The tape modifier retrieves data from the currently attached tape, rather than the actual data level of the file. The tape must have been created in a t-dump format and must be positioned to the beginning of the appropriate tape file. The attribute-defining items specified in the AQL sentence are retrieved from the dictionary level of the specified file name.","url":"https://d3codex.com/access/tape-modifier/","api":"https://d3codex.com/api/topics/access/tape-modifier.json"},{"slug":"access/tcl-supp-modifier","title":"tcl-supp modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The tcl-supp modifier suppresses the display of the AQL (TCL) sentence used to generate the report on printed output only.","url":"https://d3codex.com/access/tcl-supp-modifier/","api":"https://d3codex.com/api/topics/access/tcl-supp-modifier.json"},{"slug":"access/temporary-attribute-items","title":"Temporary attribute items","category":"ACCESS / AQL","categorySlug":"access","summary":"Attribute items using special attribute names can be specified in an AQL sentence without actually existing in either the file dictionary or the account master dictionary.","url":"https://d3codex.com/access/temporary-attribute-items/","api":"https://d3codex.com/api/topics/access/temporary-attribute-items.json"},{"slug":"access/throwaway-connectives","title":"Throwaway connectives","category":"ACCESS / AQL","categorySlug":"access","summary":"Throwaway connectives are a class of AQL modifiers that have no effect on command execution.","url":"https://d3codex.com/access/throwaway-connectives/","api":"https://d3codex.com/api/topics/access/throwaway-connectives.json"},{"slug":"access/total-modifier","title":"total modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The total modifier accumulates a columnar total for a specified attribute-defining item.","url":"https://d3codex.com/access/total-modifier/","api":"https://d3codex.com/api/topics/access/total-modifier.json"},{"slug":"access/trans-function","title":"trans() function","category":"ACCESS / AQL","categorySlug":"access","summary":"See eval modifier for more information.","url":"https://d3codex.com/access/trans-function/","api":"https://d3codex.com/api/topics/access/trans-function.json"},{"slug":"access/u1070-user-exit","title":"u1070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u1070 user exit returns a checksum for the current item.","url":"https://d3codex.com/access/u1070-user-exit/","api":"https://d3codex.com/api/topics/access/u1070-user-exit.json"},{"slug":"access/u201e-user-exit","title":"u201e user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u201e user exit returns the number of attributes in an item.","url":"https://d3codex.com/access/u201e-user-exit/","api":"https://d3codex.com/api/topics/access/u201e-user-exit.json"},{"slug":"access/u2070-user-exit","title":"u2070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u2070 user exit returns the checksum value for the specified frame.","url":"https://d3codex.com/access/u2070-user-exit/","api":"https://d3codex.com/api/topics/access/u2070-user-exit.json"},{"slug":"access/u3070-user-exit","title":"u3070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u3070 user exit returns the PCB FID for the current process as four hexadecimal digits.","url":"https://d3codex.com/access/u3070-user-exit/","api":"https://d3codex.com/api/topics/access/u3070-user-exit.json"},{"slug":"access/u5070-user-exit","title":"u5070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u5070 user exit converts a string to the form: string[1,3]: \"-000\"","url":"https://d3codex.com/access/u5070-user-exit/","api":"https://d3codex.com/api/topics/access/u5070-user-exit.json"},{"slug":"access/u508e-user-exit","title":"u508e user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u508e user exit calls the copy processor from AQL. Headings and footings may be included. This is the same as list-item or sort-item.","url":"https://d3codex.com/access/u508e-user-exit/","api":"https://d3codex.com/api/topics/access/u508e-user-exit.json"},{"slug":"access/u6070-user-exit","title":"u6070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u6070 user exit inputs up to 100 characters. A CR/LF is output immediately after the : prompt character, which displays as a request for input. The resulting input is typed in underneath the column specified by the user exit. A CR/LF is output immediately after the data is entered.","url":"https://d3codex.com/access/u6070-user-exit/","api":"https://d3codex.com/api/topics/access/u6070-user-exit.json"},{"slug":"access/u7070-user-exit","title":"u7070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u7070 user exit inputs up to 100 characters.","url":"https://d3codex.com/access/u7070-user-exit/","api":"https://d3codex.com/api/topics/access/u7070-user-exit.json"},{"slug":"access/u9070-user-exit","title":"u9070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The u9070 user exit toggles the page/nopage format. This is the same as activating the AQL n option.","url":"https://d3codex.com/access/u9070-user-exit/","api":"https://d3codex.com/api/topics/access/u9070-user-exit.json"},{"slug":"access/ua070-user-exit","title":"ua070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The ua070 user exit returns the specified value from a MultiValue set. The value count (the nth value to return) follows the attribute-defining item reference in the AQL sentence.","url":"https://d3codex.com/access/ua070-user-exit/","api":"https://d3codex.com/api/topics/access/ua070-user-exit.json"},{"slug":"access/uc070-user-exit","title":"uc070 user exit","category":"ACCESS / AQL","categorySlug":"access","summary":"The uc070 user exit returns the specified value from a MultiValue set.","url":"https://d3codex.com/access/uc070-user-exit/","api":"https://d3codex.com/api/topics/access/uc070-user-exit.json"},{"slug":"access/using-modifier","title":"using modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The using modifier allows AQL to report on the data in a given file using attribute-defining items from a different file. Only one using connective is allowed in a TCL sentence.","url":"https://d3codex.com/access/using-modifier/","api":"https://d3codex.com/api/topics/access/using-modifier.json"},{"slug":"access/with-modifier","title":"with modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The with modifier marks the beginning of a selection processor conditional, which is processed against the associated file to select items to pass on to the List processor.","url":"https://d3codex.com/access/with-modifier/","api":"https://d3codex.com/api/topics/access/with-modifier.json"},{"slug":"access/within-modifier","title":"within modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The within modifier retrieves a list of all the items that are subitems of a specified item. This is used to explode one attribute containing one or more MultiValues that are item-IDs within the same file, like in bill-of-material explosions. The file-defining item (D-pointer) must contain a v code in attribute 8 in the form: v;;n where n indicates the attribute count to explode. The explosion may proceed up to 20 sublevels.","url":"https://d3codex.com/access/within-modifier/","api":"https://d3codex.com/api/topics/access/within-modifier.json"},{"slug":"access/without-modifier","title":"without modifier","category":"ACCESS / AQL","categorySlug":"access","summary":"The without modifier negates the normal rules for selection criteria. if no, with no, and with not are identical to without.","url":"https://d3codex.com/access/without-modifier/","api":"https://d3codex.com/api/topics/access/without-modifier.json"},{"slug":"accumath/accumath","title":"Accumath","category":"Accumath","categorySlug":"accumath","summary":"AccuMath is an extended precision arithmetic utility package designed for programmers requiring more precision and significance than is available with BASIC. The package is implemented as a set of Assembler and BASIC subroutines that are callable from a BASIC program. The subroutines perform all of the standard arithmetic functions normally available, with almost unlimited significance and precision.","url":"https://d3codex.com/accumath/accumath/","api":"https://d3codex.com/api/topics/accumath/accumath.json"},{"slug":"accumath/assembler-subroutines","title":"Assembler subroutines","category":"Accumath","categorySlug":"accumath","summary":"The Assembler subroutines are another method of using AccuMath in your applications. The main advantage of using the Assembler subroutines is that they are faster than the BASIC subroutines, mainly due to the overhead of the BASIC CALL statement. The main disadvantages of using the Assembler subroutines are that they require the programmer to call the Assembler subroutines using user-exits, and they only provide the primary arithmetic operations: add, subtract, multiply, divide, compare and precision. If execution speed is a priority however, the Assembler subroutines are an acceptable method.","url":"https://d3codex.com/accumath/assembler-subroutines/","api":"https://d3codex.com/api/topics/accumath/assembler-subroutines.json"},{"slug":"accumath/basic-subroutines","title":"BASIC subroutines","category":"Accumath","categorySlug":"accumath","summary":"The BASIC subroutines are the recommended method of using AccuMath in your applications. They isolate the programmer from calling the Assembler subroutines (user-exits), and provide the greatest degree of portability and functionality.","url":"https://d3codex.com/accumath/basic-subroutines/","api":"https://d3codex.com/api/topics/accumath/basic-subroutines.json"},{"slug":"accumath/examples","title":"Examples","category":"Accumath","categorySlug":"accumath","summary":"The following examples are provided to illustrate the use of Accumath subroutines and functions in programs.","url":"https://d3codex.com/accumath/examples/","api":"https://d3codex.com/api/topics/accumath/examples.json"},{"slug":"accumath/rules-and-definitions","title":"Rules and definitions","category":"Accumath","categorySlug":"accumath","summary":"Throughout this document, the word precision is used to mean the number of fractional digits represented in a number. That is, the number of digits to the right of the decimal point.","url":"https://d3codex.com/accumath/rules-and-definitions/","api":"https://d3codex.com/api/topics/accumath/rules-and-definitions.json"},{"slug":"accumath/string-arithmetic-functions","title":"String arithmetic functions","category":"Accumath","categorySlug":"accumath","summary":"The string arithmetic functions and pre-compiler are the last method of using AccuMath in your applications. These functions are compatible with the Ultimate string math functions. Using the pre-compiler, source code compatibility with programs using Ultimate&#39;s string arithmetic functions can be maintained.","url":"https://d3codex.com/accumath/string-arithmetic-functions/","api":"https://d3codex.com/api/topics/accumath/string-arithmetic-functions.json"},{"slug":"attributedefiningitem/a-amc","title":"a/amc","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"The a/amc attribute-defining item references the attribute-count, usually of a master dictionary or a dictionary item.","url":"https://d3codex.com/attributedefiningitem/a-amc/","api":"https://d3codex.com/api/topics/attributedefiningitem/a-amc.json"},{"slug":"attributedefiningitem/a0-a99","title":"a0-a99","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"The number in the item-ID corresponds to the attribute mark that it describes.","url":"https://d3codex.com/attributedefiningitem/a0-a99/","api":"https://d3codex.com/api/topics/attributedefiningitem/a0-a99.json"},{"slug":"attributedefiningitem/account-attribute-defining-items","title":"account (Attribute-Defining Items)","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 2 of the item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/account-attribute-defining-items/","api":"https://d3codex.com/api/topics/attributedefiningitem/account-attribute-defining-items.json"},{"slug":"attributedefiningitem/an","title":"an","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the item-ID of the item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/an/","api":"https://d3codex.com/api/topics/attributedefiningitem/an.json"},{"slug":"attributedefiningitem/asterisk-a0-a13","title":"*a0-a13","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"The number in the item-ID corresponds to the attribute mark that it describes.","url":"https://d3codex.com/attributedefiningitem/asterisk-a0-a13/","api":"https://d3codex.com/api/topics/attributedefiningitem/asterisk-a0-a13.json"},{"slug":"attributedefiningitem/asterisk-a9998","title":"*a9998","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"A special attribute identifier used to produce a sequential counter for items being processed by the AQL sentence.","url":"https://d3codex.com/attributedefiningitem/asterisk-a9998/","api":"https://d3codex.com/api/topics/attributedefiningitem/asterisk-a9998.json"},{"slug":"attributedefiningitem/asterisk-a9999","title":"*a9999","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Its function is to return the size, in bytes, of the item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/asterisk-a9999/","api":"https://d3codex.com/api/topics/attributedefiningitem/asterisk-a9999.json"},{"slug":"attributedefiningitem/attr-code","title":"attr.code","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 1 of the item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/attr-code/","api":"https://d3codex.com/api/topics/attributedefiningitem/attr-code.json"},{"slug":"attributedefiningitem/attribute-count","title":"attribute-count","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the attribute-count (attribute 2) of the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/attribute-count/","api":"https://d3codex.com/api/topics/attributedefiningitem/attribute-count.json"},{"slug":"attributedefiningitem/attribute-defining-items","title":"Attribute-Defining items","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"This section discusses Attribute-Defining items.","url":"https://d3codex.com/attributedefiningitem/attribute-defining-items/","api":"https://d3codex.com/api/topics/attributedefiningitem/attribute-defining-items.json"},{"slug":"attributedefiningitem/attribute-name","title":"attribute-name","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the item-ID of the item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/attribute-name/","api":"https://d3codex.com/api/topics/attributedefiningitem/attribute-name.json"},{"slug":"attributedefiningitem/attribute-type","title":"attribute-type","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 9 of the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/attribute-type/","api":"https://d3codex.com/api/topics/attributedefiningitem/attribute-type.json"},{"slug":"attributedefiningitem/base","title":"base","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the beginning frame-ID (FID) of a series of logically contiguous frames containing the primary file space for the VME or N/A for the FSI.","url":"https://d3codex.com/attributedefiningitem/base/","api":"https://d3codex.com/api/topics/attributedefiningitem/base.json"},{"slug":"attributedefiningitem/c-acct","title":"c/acct","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays attribute 8, which is the account where a binary item (BASIC or FlashBASIC object code) was last compiled.","url":"https://d3codex.com/attributedefiningitem/c-acct/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-acct.json"},{"slug":"attributedefiningitem/c-bytes","title":"c/bytes","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays attribute 11 of compiled binary items through the list-obj TCL command. This is the number of bytes of object code. It is also available to AQL.","url":"https://d3codex.com/attributedefiningitem/c-bytes/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-bytes.json"},{"slug":"attributedefiningitem/c-code","title":"c/code","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays attribute one of a binary item that is the cc code. It is available to AQL and list-obj.","url":"https://d3codex.com/attributedefiningitem/c-code/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-code.json"},{"slug":"attributedefiningitem/c-date","title":"c/date","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the date a binary item was compiled (attribute 4). The date is stored in internal format and displayed in external format.","url":"https://d3codex.com/attributedefiningitem/c-date/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-date.json"},{"slug":"attributedefiningitem/c-fid","title":"c/fid","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays attribute 2, which is the starting frame of binary items.","url":"https://d3codex.com/attributedefiningitem/c-fid/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-fid.json"},{"slug":"attributedefiningitem/c-flash","title":"c/flash","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the number of frames of FlashBASIC code of binary items.","url":"https://d3codex.com/attributedefiningitem/c-flash/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-flash.json"},{"slug":"attributedefiningitem/c-options","title":"c/options","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the compile options used to compile a program. This attribute is stored alphabetically.","url":"https://d3codex.com/attributedefiningitem/c-options/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-options.json"},{"slug":"attributedefiningitem/c-port","title":"c/port","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the port that last compiled the program. This is used by list-obj and AQL.","url":"https://d3codex.com/attributedefiningitem/c-port/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-port.json"},{"slug":"attributedefiningitem/c-release","title":"c/release","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the release when a binary item was compiled.","url":"https://d3codex.com/attributedefiningitem/c-release/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-release.json"},{"slug":"attributedefiningitem/c-size","title":"c/size","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the number of frames of object code. This number does not include the number of FlashBASIC object code frames.","url":"https://d3codex.com/attributedefiningitem/c-size/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-size.json"},{"slug":"attributedefiningitem/c-time","title":"c/time","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the time when a binary item was compiled. This is stored in internal format and displayed in external format.","url":"https://d3codex.com/attributedefiningitem/c-time/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-time.json"},{"slug":"attributedefiningitem/c-total","title":"c/total","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the total number of frames that make up a binary item. The frame count is divided into two parts, the number frames of:","url":"https://d3codex.com/attributedefiningitem/c-total/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-total.json"},{"slug":"attributedefiningitem/c-user","title":"c/user","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the user that last compiled the binary item.","url":"https://d3codex.com/attributedefiningitem/c-user/","api":"https://d3codex.com/api/topics/attributedefiningitem/c-user.json"},{"slug":"attributedefiningitem/column-width","title":"column-width","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the initial width (attribute 10) for the display column allocated by AQL for displaying the associated data. Its initial value can be adjusted by AQL depending on the type-values used in the attribute-type attribute of the ADI. If null, the default column-width used is based upon the length of the attribute’s ID that is superseded still by the length of a substitute-header attribute in the ADI, if present.","url":"https://d3codex.com/attributedefiningitem/column-width/","api":"https://d3codex.com/api/topics/attributedefiningitem/column-width.json"},{"slug":"attributedefiningitem/cor","title":"cor","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 8 of the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/cor/","api":"https://d3codex.com/api/topics/attributedefiningitem/cor.json"},{"slug":"attributedefiningitem/d-code","title":"d/code","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 1 of the dictionary item being processed by AQL and describes the type of dictionary item. Dictionary codes beginning with d are used by file defining items, while the a, s, or x dictionary codes are used by attribute-defining items.","url":"https://d3codex.com/attributedefiningitem/d-code/","api":"https://d3codex.com/api/topics/attributedefiningitem/d-code.json"},{"slug":"attributedefiningitem/d-code1","title":"d/code1","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the first letter of attribute 1 of the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/d-code1/","api":"https://d3codex.com/api/topics/attributedefiningitem/d-code1.json"},{"slug":"attributedefiningitem/d-size","title":"d/size","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Returns the size (in bytes) of each item processed by AQL.","url":"https://d3codex.com/attributedefiningitem/d-size/","api":"https://d3codex.com/api/topics/attributedefiningitem/d-size.json"},{"slug":"attributedefiningitem/default-attribute-items-attribute-defining-items","title":"Default attribute items (Attribute-Defining Items)","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"When a new account is created, several predefined (or default attribute definition) items are included in the new account’s master dictionary.","url":"https://d3codex.com/attributedefiningitem/default-attribute-items-attribute-defining-items/","api":"https://d3codex.com/api/topics/attributedefiningitem/default-attribute-items-attribute-defining-items.json"},{"slug":"attributedefiningitem/defining-attributes","title":"Defining attributes","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"An attribute-defining item (ADI) describes, formats, and manipulates data contained within data files. They are located in a file&#39;s dictionary or in the account&#39;s master dictionary. ADIs are used by nearly all D3 processors to create data interrelationships, format data, or select data.","url":"https://d3codex.com/attributedefiningitem/defining-attributes/","api":"https://d3codex.com/api/topics/attributedefiningitem/defining-attributes.json"},{"slug":"attributedefiningitem/description","title":"Description","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the nature and usage of the attribute-defining item being processed by AQL, attribute 17.","url":"https://d3codex.com/attributedefiningitem/description/","api":"https://d3codex.com/api/topics/attributedefiningitem/description.json"},{"slug":"attributedefiningitem/dictionary-code","title":"dictionary-code","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 1 of the dictionary item being processed by AQL and describes the type of dictionary item. The dictionary codes starting with a d are used by file-defining items, while a, s and x dictionary codes are used by attribute-defining items.","url":"https://d3codex.com/attributedefiningitem/dictionary-code/","api":"https://d3codex.com/api/topics/attributedefiningitem/dictionary-code.json"},{"slug":"attributedefiningitem/f-base","title":"f/base","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the beginning FID of a series of logically contiguous frames containing the primary file space.","url":"https://d3codex.com/attributedefiningitem/f-base/","api":"https://d3codex.com/api/topics/attributedefiningitem/f-base.json"},{"slug":"attributedefiningitem/f-mod","title":"f/mod","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 3 of the file-defining item being processed by AQL and describes the modulo of that file.","url":"https://d3codex.com/attributedefiningitem/f-mod/","api":"https://d3codex.com/api/topics/attributedefiningitem/f-mod.json"},{"slug":"attributedefiningitem/f-realloc","title":"f/realloc","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 13 of the file-defining item being processed by AQL and describes the reallocation modulo for that file, if any.","url":"https://d3codex.com/attributedefiningitem/f-realloc/","api":"https://d3codex.com/api/topics/attributedefiningitem/f-realloc.json"},{"slug":"attributedefiningitem/f-sep","title":"f/sep","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 4 of the file-defining item being processed by AQL and describes the separation of that file, if any.","url":"https://d3codex.com/attributedefiningitem/f-sep/","api":"https://d3codex.com/api/topics/attributedefiningitem/f-sep.json"},{"slug":"attributedefiningitem/f-syn","title":"f/syn","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 12 of the file-defining item being processed by AQL and describes synonyms for that file.","url":"https://d3codex.com/attributedefiningitem/f-syn/","api":"https://d3codex.com/api/topics/attributedefiningitem/f-syn.json"},{"slug":"attributedefiningitem/file-code","title":"file.code","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 1 of the dictionary item being processed by AQL and describes the type of dictionary item.","url":"https://d3codex.com/attributedefiningitem/file-code/","api":"https://d3codex.com/api/topics/attributedefiningitem/file-code.json"},{"slug":"attributedefiningitem/fileflgs","title":"fileflgs","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Returns the internal file flags for file-defining items. Otherwise, a null (\"\") is returned.","url":"https://d3codex.com/attributedefiningitem/fileflgs/","api":"https://d3codex.com/api/topics/attributedefiningitem/fileflgs.json"},{"slug":"attributedefiningitem/filename","title":"filename","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the file name of the file being pointed to if attribute 1 is a q.","url":"https://d3codex.com/attributedefiningitem/filename/","api":"https://d3codex.com/api/topics/attributedefiningitem/filename.json"},{"slug":"attributedefiningitem/hotkey-all","title":"hotkey.all","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Eleven hot keys are available to provide quick access to FlashBASIC programs from within the Update processor. The hot keys are defined in a file-defining item (FDI) and attribute-defining item (ADI). The values of these keys are specified in attributes 20 through 30 in the file-defining item or attribute-defining item. Attribute 20 is hotkey.all.","url":"https://d3codex.com/attributedefiningitem/hotkey-all/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey-all.json"},{"slug":"attributedefiningitem/hotkey0","title":"hotkey0","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 30 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey0, the subroutine is executed when the command CTRL+X0 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey0/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey0.json"},{"slug":"attributedefiningitem/hotkey1","title":"hotkey1","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 21 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey1, the subroutine is executed when the command CTRL+X1 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey1/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey1.json"},{"slug":"attributedefiningitem/hotkey2","title":"hotkey2","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 22 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey2, the subroutine is executed when the command CTRL+X2 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey2/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey2.json"},{"slug":"attributedefiningitem/hotkey3","title":"hotkey3","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 23 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey3, the subroutine is executed when the command CTRL+X3 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey3/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey3.json"},{"slug":"attributedefiningitem/hotkey4","title":"hotkey4","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 24 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey4, the subroutine is executed when the command CTRL+X4 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey4/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey4.json"},{"slug":"attributedefiningitem/hotkey5","title":"hotkey5","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 25 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey5, the subroutine is executed when the command CTRL+X5 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey5/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey5.json"},{"slug":"attributedefiningitem/hotkey6","title":"hotkey6","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 26 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey6, the subroutine is executed when the command CTRL+X6 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey6/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey6.json"},{"slug":"attributedefiningitem/hotkey7","title":"hotkey7","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 27 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey7, the subroutine is executed when the command CTRL+X7 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey7/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey7.json"},{"slug":"attributedefiningitem/hotkey8","title":"hotkey8","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 28 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey8, the subroutine is executed when the command CTRL+X8 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey8/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey8.json"},{"slug":"attributedefiningitem/hotkey9","title":"hotkey9","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 29 of a dictionary item. If there is a FlashBASIC subroutine called on hotkey9, the subroutine is executed when the command CTRL+X9 is executed.","url":"https://d3codex.com/attributedefiningitem/hotkey9/","api":"https://d3codex.com/api/topics/attributedefiningitem/hotkey9.json"},{"slug":"attributedefiningitem/icv","title":"icv","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the processing codes applied at input time, stored in attribute 14. These codes may be used for data validation as well as data transformation.","url":"https://d3codex.com/attributedefiningitem/icv/","api":"https://d3codex.com/api/topics/attributedefiningitem/icv.json"},{"slug":"attributedefiningitem/input-conversion","title":"input-conversion","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the processing codes applied at input time, stored in attribute 14 of a dictionary. This dictionary attribute is used exclusively by the Update processor. There are many processing codes that can be called from input-conversion on both file-defining items and attribute-defining items.","url":"https://d3codex.com/attributedefiningitem/input-conversion/","api":"https://d3codex.com/api/topics/attributedefiningitem/input-conversion.json"},{"slug":"attributedefiningitem/item-id-attribute-defining-items","title":"item-ID (attribute-defining items)","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 0 of the current item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/item-id-attribute-defining-items/","api":"https://d3codex.com/api/topics/attributedefiningitem/item-id-attribute-defining-items.json"},{"slug":"attributedefiningitem/itmflgs","title":"itmflgs","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Returns the internal item flags for file-defining items. Returns null (\"\") if no internal flags are set.","url":"https://d3codex.com/attributedefiningitem/itmflgs/","api":"https://d3codex.com/api/topics/attributedefiningitem/itmflgs.json"},{"slug":"attributedefiningitem/justification","title":"justification","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the justification specification of the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/justification/","api":"https://d3codex.com/api/topics/attributedefiningitem/justification.json"},{"slug":"attributedefiningitem/l-ret","title":"l/ret","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 5 of a dictionary item and describes retrieval-lock codes specified for that file-defining item, if any.","url":"https://d3codex.com/attributedefiningitem/l-ret/","api":"https://d3codex.com/api/topics/attributedefiningitem/l-ret.json"},{"slug":"attributedefiningitem/l-upd","title":"l/upd","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 6 of a dictionary item and describes update-lock codes specified for that file-defining item.","url":"https://d3codex.com/attributedefiningitem/l-upd/","api":"https://d3codex.com/api/topics/attributedefiningitem/l-upd.json"},{"slug":"attributedefiningitem/m-dict","title":"m/dict","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"m/dict is an alternate means of referencing the master dictionary of the current account. It is a Q-pointer that points to the current master dictionary.","url":"https://d3codex.com/attributedefiningitem/m-dict/","api":"https://d3codex.com/api/topics/attributedefiningitem/m-dict.json"},{"slug":"attributedefiningitem/macro","title":"macro","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 15 of a file or attribute-defining item. For a file-defining item, the text in this field describes the default attribute name list to include in the update screen. For an attribute-defining item, the text describes the default attribute name list when zooming to another item.","url":"https://d3codex.com/attributedefiningitem/macro/","api":"https://d3codex.com/api/topics/attributedefiningitem/macro.json"},{"slug":"attributedefiningitem/md-name","title":"md.name","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 2 of master dictionary items. For Q-pointers, md.name describes the name of the file being pointed to.","url":"https://d3codex.com/attributedefiningitem/md-name/","api":"https://d3codex.com/api/topics/attributedefiningitem/md-name.json"},{"slug":"attributedefiningitem/modulo-attribute-defining-items","title":"modulo","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 3 of the file-defining item being processed by AQL and describes the size of that file.","url":"https://d3codex.com/attributedefiningitem/modulo-attribute-defining-items/","api":"https://d3codex.com/api/topics/attributedefiningitem/modulo-attribute-defining-items.json"},{"slug":"attributedefiningitem/out-conv","title":"out.conv","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 14 of file or attribute-defining items and describes the output-conversion codes that modify the value prior to display.","url":"https://d3codex.com/attributedefiningitem/out-conv/","api":"https://d3codex.com/api/topics/attributedefiningitem/out-conv.json"},{"slug":"attributedefiningitem/output-conversion","title":"output-conversion","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 7 of a dictionary. There are many processing codes that can be called from output-conversion on both file-defining and attribute-defining items.","url":"https://d3codex.com/attributedefiningitem/output-conversion/","api":"https://d3codex.com/api/topics/attributedefiningitem/output-conversion.json"},{"slug":"attributedefiningitem/output-macro","title":"output-macro","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 16 of file-defining items. For file-defining items, the text in output-macro describes the default attribute list to be used in an AQL report. For a file-defining item, the text in this field is substituted into any TCL statement that outputs this file. For an attribute-defining item, this attribute has no relevance.","url":"https://d3codex.com/attributedefiningitem/output-macro/","api":"https://d3codex.com/api/topics/attributedefiningitem/output-macro.json"},{"slug":"attributedefiningitem/r0","title":"r0","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the item-ID, right justified, for sorting purposes.","url":"https://d3codex.com/attributedefiningitem/r0/","api":"https://d3codex.com/api/topics/attributedefiningitem/r0.json"},{"slug":"attributedefiningitem/reallocation","title":"reallocation","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Used to resize a file when it is restored. Before the file is saved, the new modulo is placed into attribute 13 of a file-defining item. During an account-restore or full file restore, the file is restored at the new size. If a file is too small, updating attribute 13 and account-save, delete-account, then account-restore causes the system to allocate more frames in the primary space for the file.","url":"https://d3codex.com/attributedefiningitem/reallocation/","api":"https://d3codex.com/api/topics/attributedefiningitem/reallocation.json"},{"slug":"attributedefiningitem/retrieval-lock","title":"retrieval-lock","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 5 of a dictionary item and describes the retrieval-lock code specified for that file-defining item. The retrieval lock controls access to the file for retrieval.","url":"https://d3codex.com/attributedefiningitem/retrieval-lock/","api":"https://d3codex.com/api/topics/attributedefiningitem/retrieval-lock.json"},{"slug":"attributedefiningitem/s-amc","title":"s/amc","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 4 of attribute-defining items and describes the controlling/dependent code specifications.","url":"https://d3codex.com/attributedefiningitem/s-amc/","api":"https://d3codex.com/api/topics/attributedefiningitem/s-amc.json"},{"slug":"attributedefiningitem/s-name","title":"s/name","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 3 of attribute-defining items and describes the substitute-header for that attribute.","url":"https://d3codex.com/attributedefiningitem/s-name/","api":"https://d3codex.com/api/topics/attributedefiningitem/s-name.json"},{"slug":"attributedefiningitem/size","title":"size","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Its function is to return the size, in bytes, of the item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/size/","api":"https://d3codex.com/api/topics/attributedefiningitem/size.json"},{"slug":"attributedefiningitem/structure","title":"structure","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 4 of attribute-defining items and describes the controlling/dependent code specifications.","url":"https://d3codex.com/attributedefiningitem/structure/","api":"https://d3codex.com/api/topics/attributedefiningitem/structure.json"},{"slug":"attributedefiningitem/substitute-header","title":"substitute-header","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 3 of attribute-defining items and describes the substitute-header for that attribute of the ADI. This can affect the column width if it is longer than the column-width ADI.","url":"https://d3codex.com/attributedefiningitem/substitute-header/","api":"https://d3codex.com/api/topics/attributedefiningitem/substitute-header.json"},{"slug":"attributedefiningitem/summary","title":"summary","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays master dictionary items in a generic format.","url":"https://d3codex.com/attributedefiningitem/summary/","api":"https://d3codex.com/api/topics/attributedefiningitem/summary.json"},{"slug":"attributedefiningitem/synonym","title":"synonym","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 12 of the file-defining item being processed by AQL and describes any synonyms for that file.","url":"https://d3codex.com/attributedefiningitem/synonym/","api":"https://d3codex.com/api/topics/attributedefiningitem/synonym.json"},{"slug":"attributedefiningitem/ulk","title":"ulk","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"The ulk attribute defining item references attribute 6 of a file-defining item describing the file’s update lock codes.","url":"https://d3codex.com/attributedefiningitem/ulk/","api":"https://d3codex.com/api/topics/attributedefiningitem/ulk.json"},{"slug":"attributedefiningitem/update-lock","title":"update-lock","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 6 of a dictionary item and describes the update-lock code specified for that file-defining item.","url":"https://d3codex.com/attributedefiningitem/update-lock/","api":"https://d3codex.com/api/topics/attributedefiningitem/update-lock.json"},{"slug":"attributedefiningitem/user-defined-default-dictionary-items","title":"User-defined default dictionary items","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"These default attribute defining items are found in the dictionary of the data file. If no ADIs are explicitly requested in an AQL report, the default fields display automatically.","url":"https://d3codex.com/attributedefiningitem/user-defined-default-dictionary-items/","api":"https://d3codex.com/api/topics/attributedefiningitem/user-defined-default-dictionary-items.json"},{"slug":"attributedefiningitem/v-cat","title":"v/cat","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the file and program name for cataloged FlashBASIC programs.","url":"https://d3codex.com/attributedefiningitem/v-cat/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-cat.json"},{"slug":"attributedefiningitem/v-conv","title":"v/conv","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 7 of an attribute-defining items and describes the output-conversion codes that modify the value prior to display.","url":"https://d3codex.com/attributedefiningitem/v-conv/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-conv.json"},{"slug":"attributedefiningitem/v-corr","title":"v/corr","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 8 of the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/v-corr/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-corr.json"},{"slug":"attributedefiningitem/v-desc","title":"v/desc","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the nature and usage of the attribute-defining item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/v-desc/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-desc.json"},{"slug":"attributedefiningitem/v-flags","title":"v/flags","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"For MD commands, the flags that define options for the TCL processor.","url":"https://d3codex.com/attributedefiningitem/v-flags/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-flags.json"},{"slug":"attributedefiningitem/v-max","title":"v/max","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References the number of columns allocated for the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/v-max/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-max.json"},{"slug":"attributedefiningitem/v-mode","title":"v/mode","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Defines the virtual jump table definitions for commands, or explanations for macros and Procs.","url":"https://d3codex.com/attributedefiningitem/v-mode/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-mode.json"},{"slug":"attributedefiningitem/v-name","title":"v/name","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Describes the item-ID of a TCL command item.","url":"https://d3codex.com/attributedefiningitem/v-name/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-name.json"},{"slug":"attributedefiningitem/v-struc","title":"v/struc","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 4 of attribute-defining items and describes the controlling/dependent code specifications.","url":"https://d3codex.com/attributedefiningitem/v-struc/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-struc.json"},{"slug":"attributedefiningitem/v-tag","title":"v/tag","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"References attribute 3 of attribute-defining items and describes the substitute header for that attribute.","url":"https://d3codex.com/attributedefiningitem/v-tag/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-tag.json"},{"slug":"attributedefiningitem/v-typ","title":"v/typ","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Displays the justification specification of the dictionary item being processed by AQL.","url":"https://d3codex.com/attributedefiningitem/v-typ/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-typ.json"},{"slug":"attributedefiningitem/v-type","title":"v/type","category":"Attribute-Defining Items","categorySlug":"attributedefiningitem","summary":"Determines the type of TCL command.","url":"https://d3codex.com/attributedefiningitem/v-type/","api":"https://d3codex.com/api/topics/attributedefiningitem/v-type.json"},{"slug":"backgroundphantomprocess/background-command","title":"background command","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The background command starts a phantom job with rerun and delay facilities.","url":"https://d3codex.com/backgroundphantomprocess/background-command/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/background-command.json"},{"slug":"backgroundphantomprocess/background-phantom-process","title":"Background/Phantom process","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"This section discusses the Background Phantom processor.","url":"https://d3codex.com/backgroundphantomprocess/background-phantom-process/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/background-phantom-process.json"},{"slug":"backgroundphantomprocess/background-phantom-process-commands","title":"Background/Phantom process commands","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The following background/phantom process commands are available.","url":"https://d3codex.com/backgroundphantomprocess/background-phantom-process-commands/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/background-phantom-process-commands.json"},{"slug":"backgroundphantomprocess/background-phantom-process-overview","title":"Background/Phantom process overview","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"A phantom process is a process that is initiated at a terminal and detaches itself from that terminal for execution independent of that terminal. It is processed as a background task and the results display on the initiating terminal when the process is complete.","url":"https://d3codex.com/backgroundphantomprocess/background-phantom-process-overview/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/background-phantom-process-overview.json"},{"slug":"backgroundphantomprocess/backgrounds-disable-missed-command","title":"backgrounds-disable-missed command","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The backgrounds-disable-missed command disables running any scheduled background processor jobs that were missed due to the background processor being stopped (either manually or because of a service disruption).","url":"https://d3codex.com/backgroundphantomprocess/backgrounds-disable-missed-command/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/backgrounds-disable-missed-command.json"},{"slug":"backgroundphantomprocess/colon-background-start-command","title":":background-start command","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The :background-start command starts the background processor. The background command will not run unless the background processor has been started with this command. This command is automatically run by the coldstart procedure.","url":"https://d3codex.com/backgroundphantomprocess/colon-background-start-command/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/colon-background-start-command.json"},{"slug":"backgroundphantomprocess/colon-background-stop-command","title":":background-stop command","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The :background-stop command stops the background processor. The background scheduler will no longer be able to run. Jobs can still be queued for execution when the scheduler is not running, but they will not start. This command has no effect on backgrounds that are already running. To stop those jobs, they must be logged off.","url":"https://d3codex.com/backgroundphantomprocess/colon-background-stop-command/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/colon-background-stop-command.json"},{"slug":"backgroundphantomprocess/end-command-background-phantom-process-commands","title":"end command (Background/Phantom process commands)","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The end command terminates a process on another port, or the current port if a port number is not specified.","url":"https://d3codex.com/backgroundphantomprocess/end-command-background-phantom-process-commands/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/end-command-background-phantom-process-commands.json"},{"slug":"backgroundphantomprocess/list-backgrounds-missed-command","title":"list-backgrounds-missed command","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The list-backgrounds-missed command lists any scheduled background processor jobs that were missed due to the background processor being stopped (either manually or because of a service disruption).","url":"https://d3codex.com/backgroundphantomprocess/list-backgrounds-missed-command/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/list-backgrounds-missed-command.json"},{"slug":"backgroundphantomprocess/startsched-command","title":"startsched command","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The startsched command starts the phantom scheduler, which itself is a phantom process. The scheduler is normally started on the last phantom port of the system.","url":"https://d3codex.com/backgroundphantomprocess/startsched-command/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/startsched-command.json"},{"slug":"backgroundphantomprocess/z-command-background-phantom-process-commands","title":"z command (Background/Phantom process commands)","category":"Background / Phantom","categorySlug":"backgroundphantomprocess","summary":"The z command starts a phantom job. Phantom jobs run in the background, meaning that they do not necessarily need a terminal present.","url":"https://d3codex.com/backgroundphantomprocess/z-command-background-phantom-process-commands/","api":"https://d3codex.com/api/topics/backgroundphantomprocess/z-command-background-phantom-process-commands.json"},{"slug":"cfunctions/break-key-handling","title":"Break key handling","category":"C Functions","categorySlug":"cfunctions","summary":"When logged into D3, the default action for the BREAK key is set to push a level or drop into the debugger as is standard in D3. This behavior may be changed however by using these calls:","url":"https://d3codex.com/cfunctions/break-key-handling/","api":"https://d3codex.com/api/topics/cfunctions/break-key-handling.json"},{"slug":"cfunctions/c-functions-integration","title":"C functions, integration","category":"C Functions","categorySlug":"cfunctions","summary":"The steps necessary to integrate a user C program with the D3 run-time library are:","url":"https://d3codex.com/cfunctions/c-functions-integration/","api":"https://d3codex.com/api/topics/cfunctions/c-functions-integration.json"},{"slug":"cfunctions/c-functions-overview","title":"C functions overview","category":"C Functions","categorySlug":"cfunctions","summary":"The functionality of the D3 environment is available from the C programming language. This is made available through a set of functions and macros defined in the include file CPuser.h.","url":"https://d3codex.com/cfunctions/c-functions-overview/","api":"https://d3codex.com/api/topics/cfunctions/c-functions-overview.json"},{"slug":"cfunctions/c-programming-language-c-functions","title":"C programming language C functions","category":"C Functions","categorySlug":"cfunctions","summary":"This section discusses C programming language functions.","url":"https://d3codex.com/cfunctions/c-programming-language-c-functions/","api":"https://d3codex.com/api/topics/cfunctions/c-programming-language-c-functions.json"},{"slug":"cfunctions/c-programming-language-c-functions-list","title":"C programming language C functions list","category":"C Functions","categorySlug":"cfunctions","summary":"The following C functions are available.","url":"https://d3codex.com/cfunctions/c-programming-language-c-functions-list/","api":"https://d3codex.com/api/topics/cfunctions/c-programming-language-c-functions-list.json"},{"slug":"cfunctions/c-string","title":"C string","category":"C Functions","categorySlug":"cfunctions","summary":"C string is a series of characters terminated by a null (0x00) character usually used in C.","url":"https://d3codex.com/cfunctions/c-string/","api":"https://d3codex.com/api/topics/cfunctions/c-string.json"},{"slug":"cfunctions/cp-alpha","title":"_CP_alpha","category":"C Functions","categorySlug":"cfunctions","summary":"The _CP_alpha function is equivalent to the result = alpha(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-alpha/","api":"https://d3codex.com/api/topics/cfunctions/cp-alpha.json"},{"slug":"cfunctions/cp-ascii","title":"_CP_ascii","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_ascii is equivalent to the result = ascii(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-ascii/","api":"https://d3codex.com/api/topics/cfunctions/cp-ascii.json"},{"slug":"cfunctions/cp-at1","title":"_CP_at1","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_at1 is equivalent to the result = @(x) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-at1/","api":"https://d3codex.com/api/topics/cfunctions/cp-at1.json"},{"slug":"cfunctions/cp-at2","title":"_CP_at2","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_at2 is equivalent to the result = @(x,y) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-at2/","api":"https://d3codex.com/api/topics/cfunctions/cp-at2.json"},{"slug":"cfunctions/cp-atvar","title":"_CP_atvar","category":"C Functions","categorySlug":"cfunctions","summary":"The _CP_atvar function reads and writes D3 shell variables. It is equivalent to the BASIC u91 user exit.","url":"https://d3codex.com/cfunctions/cp-atvar/","api":"https://d3codex.com/api/topics/cfunctions/cp-atvar.json"},{"slug":"cfunctions/cp-break","title":"_CP_break","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_break is equivalent to the break expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-break/","api":"https://d3codex.com/api/topics/cfunctions/cp-break.json"},{"slug":"cfunctions/cp-build-msg","title":"_CP_build_msg","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_build_msg queues up arguments for _CP_out_msg. This function, in conjunction with _CP_out_msg, is equivalent to the BASIC error statement. Each parameter is first stacked with _CP_build_msg, and then output with the _CP_out_msg.","url":"https://d3codex.com/cfunctions/cp-build-msg/","api":"https://d3codex.com/api/topics/cfunctions/cp-build-msg.json"},{"slug":"cfunctions/cp-call","title":"_CP_call","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_call is equivalent to the call name( {string1 {, string2 {, ...}}}) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-call/","api":"https://d3codex.com/api/topics/cfunctions/cp-call.json"},{"slug":"cfunctions/cp-casing","title":"_CP_casing","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_casing is equivalent to the casing expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-casing/","api":"https://d3codex.com/api/topics/cfunctions/cp-casing.json"},{"slug":"cfunctions/cp-cat","title":"_CP_cat","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_cat is equivalent to the result = string1:string2 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-cat/","api":"https://d3codex.com/api/topics/cfunctions/cp-cat.json"},{"slug":"cfunctions/cp-clearfile","title":"_CP_clearfile","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_clearfile is equivalent to the clearfile BASIC statement.","url":"https://d3codex.com/cfunctions/cp-clearfile/","api":"https://d3codex.com/api/topics/cfunctions/cp-clearfile.json"},{"slug":"cfunctions/cp-clearselect","title":"_CP_clearselect","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_clearselect is equivalent to the clearselect BASIC statement.","url":"https://d3codex.com/cfunctions/cp-clearselect/","api":"https://d3codex.com/api/topics/cfunctions/cp-clearselect.json"},{"slug":"cfunctions/cp-close","title":"_CP_close","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_close is equivalent to the close BASIC statement.","url":"https://d3codex.com/cfunctions/cp-close/","api":"https://d3codex.com/api/topics/cfunctions/cp-close.json"},{"slug":"cfunctions/cp-col1","title":"_CP_col1","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_col1 is equivalent to the result = col1 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-col1/","api":"https://d3codex.com/api/topics/cfunctions/cp-col1.json"},{"slug":"cfunctions/cp-col2","title":"_CP_col2","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_col2 is equivalent to the result = col2 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-col2/","api":"https://d3codex.com/api/topics/cfunctions/cp-col2.json"},{"slug":"cfunctions/cp-compare","title":"_CP_compare","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_compare is equivalent to the result = (string1 = string2) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-compare/","api":"https://d3codex.com/api/topics/cfunctions/cp-compare.json"},{"slug":"cfunctions/cp-convert","title":"_CP_convert","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_convert is equivalent to the convert string1 to string2 in result BASIC statement.","url":"https://d3codex.com/cfunctions/cp-convert/","api":"https://d3codex.com/api/topics/cfunctions/cp-convert.json"},{"slug":"cfunctions/cp-count","title":"_CP_count","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_count is equivalent to the result = count(string1, string2) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-count/","api":"https://d3codex.com/api/topics/cfunctions/cp-count.json"},{"slug":"cfunctions/cp-crt","title":"_CP_crt","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_crt is equivalent to the crt BASIC statement.","url":"https://d3codex.com/cfunctions/cp-crt/","api":"https://d3codex.com/api/topics/cfunctions/cp-crt.json"},{"slug":"cfunctions/cp-crt-n","title":"_CP_crt_n","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_crt_n is equivalent to the crt BASIC statement.","url":"https://d3codex.com/cfunctions/cp-crt-n/","api":"https://d3codex.com/api/topics/cfunctions/cp-crt-n.json"},{"slug":"cfunctions/cp-data","title":"_CP_data","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_data is equivalent to the data string BASIC statement.","url":"https://d3codex.com/cfunctions/cp-data/","api":"https://d3codex.com/api/topics/cfunctions/cp-data.json"},{"slug":"cfunctions/cp-date","title":"_CP_date","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_date is equivalent to the result = date() BASIC statement.","url":"https://d3codex.com/cfunctions/cp-date/","api":"https://d3codex.com/api/topics/cfunctions/cp-date.json"},{"slug":"cfunctions/cp-dcount","title":"_CP_dcount","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_dcount is equivalent to the result = dcount(string1, string2) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-dcount/","api":"https://d3codex.com/api/topics/cfunctions/cp-dcount.json"},{"slug":"cfunctions/cp-debug","title":"_CP_debug","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_debug is equivalent to the debug BASIC statement.","url":"https://d3codex.com/cfunctions/cp-debug/","api":"https://d3codex.com/api/topics/cfunctions/cp-debug.json"},{"slug":"cfunctions/cp-delete","title":"_CP_delete","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_delete is equivalent to the result = delete(string, ac.expression, vc.expression, sc.expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-delete/","api":"https://d3codex.com/api/topics/cfunctions/cp-delete.json"},{"slug":"cfunctions/cp-delete-item","title":"_CP_delete_item","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_delete_item is equivalent to the delete expression,string BASIC statement.","url":"https://d3codex.com/cfunctions/cp-delete-item/","api":"https://d3codex.com/api/topics/cfunctions/cp-delete-item.json"},{"slug":"cfunctions/cp-dtx","title":"_CP_dtx","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_dtx is equivalent to the result = dtx(expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-dtx/","api":"https://d3codex.com/api/topics/cfunctions/cp-dtx.json"},{"slug":"cfunctions/cp-ebcdic","title":"_CP_ebcdic","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_ebcdic is equivalent to the result = ebcdic(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-ebcdic/","api":"https://d3codex.com/api/topics/cfunctions/cp-ebcdic.json"},{"slug":"cfunctions/cp-echo","title":"_CP_echo","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_echo is equivalent to the echo expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-echo/","api":"https://d3codex.com/api/topics/cfunctions/cp-echo.json"},{"slug":"cfunctions/cp-execute","title":"_CP_execute","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_execute is equivalent to the execute command capturing string1 returning string2 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-execute/","api":"https://d3codex.com/api/topics/cfunctions/cp-execute.json"},{"slug":"cfunctions/cp-extract","title":"_CP_extract","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_extract is equivalent to the result = extract(string, ac.expression, vc.expression, sc.expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-extract/","api":"https://d3codex.com/api/topics/cfunctions/cp-extract.json"},{"slug":"cfunctions/cp-field","title":"_CP_field","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_field is equivalent to the result = field(string1, string2, expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-field/","api":"https://d3codex.com/api/topics/cfunctions/cp-field.json"},{"slug":"cfunctions/cp-field-store","title":"_CP_field_store","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_field_store is equivalent to the result[string2, expression1, expression2] = string1 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-field-store/","api":"https://d3codex.com/api/topics/cfunctions/cp-field-store.json"},{"slug":"cfunctions/cp-filelock","title":"_CP_filelock","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_filelock is equivalent to the filelock expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-filelock/","api":"https://d3codex.com/api/topics/cfunctions/cp-filelock.json"},{"slug":"cfunctions/cp-fileunlock","title":"_CP_fileunlock","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_fileunlock is equivalent to the fileunlock expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-fileunlock/","api":"https://d3codex.com/api/topics/cfunctions/cp-fileunlock.json"},{"slug":"cfunctions/cp-fold","title":"_CP_fold","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_fold is equivalent to the result = fold(string1, string2, string3) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-fold/","api":"https://d3codex.com/api/topics/cfunctions/cp-fold.json"},{"slug":"cfunctions/cp-footing","title":"_CP_footing","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_footing is equivalent to the footing string BASIC statement.","url":"https://d3codex.com/cfunctions/cp-footing/","api":"https://d3codex.com/api/topics/cfunctions/cp-footing.json"},{"slug":"cfunctions/cp-get","title":"_CP_get","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_get is equivalent to the following BASIC statement:","url":"https://d3codex.com/cfunctions/cp-get/","api":"https://d3codex.com/api/topics/cfunctions/cp-get.json"},{"slug":"cfunctions/cp-heading","title":"_CP_heading","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_heading is equivalent to the heading string BASIC statement.","url":"https://d3codex.com/cfunctions/cp-heading/","api":"https://d3codex.com/api/topics/cfunctions/cp-heading.json"},{"slug":"cfunctions/cp-iconv","title":"_CP_iconv","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_iconv is equivalent to the result = iconv(string1, string2) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-iconv/","api":"https://d3codex.com/api/topics/cfunctions/cp-iconv.json"},{"slug":"cfunctions/cp-in","title":"_CP_in","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_in is equivalent to the in result for expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-in/","api":"https://d3codex.com/api/topics/cfunctions/cp-in.json"},{"slug":"cfunctions/cp-index","title":"_CP_index","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_index is equivalent to the result = index(string1, string2, expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-index/","api":"https://d3codex.com/api/topics/cfunctions/cp-index.json"},{"slug":"cfunctions/cp-input","title":"_CP_input","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_input is equivalent to the input BASIC statement.","url":"https://d3codex.com/cfunctions/cp-input/","api":"https://d3codex.com/api/topics/cfunctions/cp-input.json"},{"slug":"cfunctions/cp-insert","title":"_CP_insert","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_insert is equivalent to the result = insert(string1, ac.expression, vc.expression, sc.expression, string2) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-insert/","api":"https://d3codex.com/api/topics/cfunctions/cp-insert.json"},{"slug":"cfunctions/cp-interrupt","title":"_CP_interrupt","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_interrupt is a global C integer which contains the last D3 interrupt that occurred. This value is the same as that returned by the BASIC function system(37). It is available when linking with the D3 libraries.","url":"https://d3codex.com/cfunctions/cp-interrupt/","api":"https://d3codex.com/api/topics/cfunctions/cp-interrupt.json"},{"slug":"cfunctions/cp-is","title":"_CP_is_","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_is_ converts an integer into a CPSTR.","url":"https://d3codex.com/cfunctions/cp-is/","api":"https://d3codex.com/api/topics/cfunctions/cp-is.json"},{"slug":"cfunctions/cp-key","title":"_CP_key","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_key is equivalent to the key(string1, expression, string2, string3) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-key/","api":"https://d3codex.com/api/topics/cfunctions/cp-key.json"},{"slug":"cfunctions/cp-load","title":"_CP_load","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_load is an optional function for preloading BASIC subroutines, before they are needed.","url":"https://d3codex.com/cfunctions/cp-load/","api":"https://d3codex.com/api/topics/cfunctions/cp-load.json"},{"slug":"cfunctions/cp-locate","title":"_CP_locate","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_locate is equivalent to the following BASIC statement:","url":"https://d3codex.com/cfunctions/cp-locate/","api":"https://d3codex.com/api/topics/cfunctions/cp-locate.json"},{"slug":"cfunctions/cp-lock","title":"_CP_lock","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_lock is equivalent to the lock BASIC statement.","url":"https://d3codex.com/cfunctions/cp-lock/","api":"https://d3codex.com/api/topics/cfunctions/cp-lock.json"},{"slug":"cfunctions/cp-logon","title":"_CP_logon","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_logon logs in to D3 from a C main program. This function must be called prior to any other function. This function returns -1 if an error occurs. The error code is contained in _CP_errno.","url":"https://d3codex.com/cfunctions/cp-logon/","api":"https://d3codex.com/api/topics/cfunctions/cp-logon.json"},{"slug":"cfunctions/cp-match","title":"_CP_match","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_match is equivalent to the result = string1 match string2 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-match/","api":"https://d3codex.com/api/topics/cfunctions/cp-match.json"},{"slug":"cfunctions/cp-mkstr","title":"_CP_mkstr","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_mkstr dynamically allocates a CPSTR* and fills it with a copy of cstring.","url":"https://d3codex.com/cfunctions/cp-mkstr/","api":"https://d3codex.com/api/topics/cfunctions/cp-mkstr.json"},{"slug":"cfunctions/cp-mkstrl","title":"_CP_mkstrl","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_mkstrl dynamically allocates a CPSTR* of length expression and fills it with a copy of cstring.","url":"https://d3codex.com/cfunctions/cp-mkstrl/","api":"https://d3codex.com/api/topics/cfunctions/cp-mkstrl.json"},{"slug":"cfunctions/cp-num","title":"_CP_num","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_num is equivalent to the result = num(string) BASIC function.","url":"https://d3codex.com/cfunctions/cp-num/","api":"https://d3codex.com/api/topics/cfunctions/cp-num.json"},{"slug":"cfunctions/cp-occurs","title":"_CP_occurs","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_occurs is equivalent to the result = occurs(string, expression) BASIC function.","url":"https://d3codex.com/cfunctions/cp-occurs/","api":"https://d3codex.com/api/topics/cfunctions/cp-occurs.json"},{"slug":"cfunctions/cp-oconv","title":"_CP_oconv","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_oconv is equivalent to the result = oconv(string1, string2) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-oconv/","api":"https://d3codex.com/api/topics/cfunctions/cp-oconv.json"},{"slug":"cfunctions/cp-open","title":"_CP_open","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_open is equivalent to the open string1,string2 to fd BASIC statement.","url":"https://d3codex.com/cfunctions/cp-open/","api":"https://d3codex.com/api/topics/cfunctions/cp-open.json"},{"slug":"cfunctions/cp-out","title":"_CP_out","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_out is equivalent to the out BASIC statement.","url":"https://d3codex.com/cfunctions/cp-out/","api":"https://d3codex.com/api/topics/cfunctions/cp-out.json"},{"slug":"cfunctions/cp-out-msg","title":"_CP_out_msg","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_out_msg outputs an error message which has been previously queued by _CP_build_msg. See _CP_build_msg for a coding example.","url":"https://d3codex.com/cfunctions/cp-out-msg/","api":"https://d3codex.com/api/topics/cfunctions/cp-out-msg.json"},{"slug":"cfunctions/cp-ovfly-subs","title":"_CP_ovfly_subs","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_ovfly_subs is equivalent to the result[expression1, expression2] = string1 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-ovfly-subs/","api":"https://d3codex.com/api/topics/cfunctions/cp-ovfly-subs.json"},{"slug":"cfunctions/cp-page","title":"_CP_page","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_page is equivalent to the page BASIC statement.","url":"https://d3codex.com/cfunctions/cp-page/","api":"https://d3codex.com/api/topics/cfunctions/cp-page.json"},{"slug":"cfunctions/cp-page-n","title":"_CP_page_n","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_page_n is equivalent to the page expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-page-n/","api":"https://d3codex.com/api/topics/cfunctions/cp-page-n.json"},{"slug":"cfunctions/cp-pick-break","title":"_CP_pick_break","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_pick_break causes all subsequent breaks to push a level or drop into the debugger as is standard in D3.","url":"https://d3codex.com/cfunctions/cp-pick-break/","api":"https://d3codex.com/api/topics/cfunctions/cp-pick-break.json"},{"slug":"cfunctions/cp-pick-env","title":"_CP_pick_env","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_pick_env sets the application to a standard D3 environment. When using this setting, all terminal input and output must be done via D3 routines only (execute, print, crt). The default environment after logging on to D3 is _CP_pick_env.","url":"https://d3codex.com/cfunctions/cp-pick-env/","api":"https://d3codex.com/api/topics/cfunctions/cp-pick-env.json"},{"slug":"cfunctions/cp-precision","title":"_CP_precision","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_precision is equivalent to the precision number BASIC statement.","url":"https://d3codex.com/cfunctions/cp-precision/","api":"https://d3codex.com/api/topics/cfunctions/cp-precision.json"},{"slug":"cfunctions/cp-print","title":"_CP_print","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_print is equivalent to the print string BASIC statement.","url":"https://d3codex.com/cfunctions/cp-print/","api":"https://d3codex.com/api/topics/cfunctions/cp-print.json"},{"slug":"cfunctions/cp-print-n","title":"_CP_print_n","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_print_n is equivalent to the print string BASIC statement.","url":"https://d3codex.com/cfunctions/cp-print-n/","api":"https://d3codex.com/api/topics/cfunctions/cp-print-n.json"},{"slug":"cfunctions/cp-print-on","title":"_CP_print_on","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_print_on is equivalent to the print on expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-print-on/","api":"https://d3codex.com/api/topics/cfunctions/cp-print-on.json"},{"slug":"cfunctions/cp-printer","title":"_CP_printer","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_printer is equivalent to the printer expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-printer/","api":"https://d3codex.com/api/topics/cfunctions/cp-printer.json"},{"slug":"cfunctions/cp-prompt","title":"_CP_prompt","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_prompt is equivalent to the prompt BASIC statement.","url":"https://d3codex.com/cfunctions/cp-prompt/","api":"https://d3codex.com/api/topics/cfunctions/cp-prompt.json"},{"slug":"cfunctions/cp-read","title":"_CP_read","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_read is equivalent to the read, readu and readu locked BASIC statements (depending upon type):","url":"https://d3codex.com/cfunctions/cp-read/","api":"https://d3codex.com/api/topics/cfunctions/cp-read.json"},{"slug":"cfunctions/cp-readfields","title":"_CP_readfields","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_readfields supports reading a set of named fields.","url":"https://d3codex.com/cfunctions/cp-readfields/","api":"https://d3codex.com/api/topics/cfunctions/cp-readfields.json"},{"slug":"cfunctions/cp-readnext","title":"_CP_readnext","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_readnext is equivalent to the readnext result,value from list BASIC statement.","url":"https://d3codex.com/cfunctions/cp-readnext/","api":"https://d3codex.com/api/topics/cfunctions/cp-readnext.json"},{"slug":"cfunctions/cp-readt","title":"_CP_readt","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_readt is equivalent to the readt BASIC statement.","url":"https://d3codex.com/cfunctions/cp-readt/","api":"https://d3codex.com/api/topics/cfunctions/cp-readt.json"},{"slug":"cfunctions/cp-readv","title":"_CP_readv","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_readv is equivalent to the readv BASIC statement.","url":"https://d3codex.com/cfunctions/cp-readv/","api":"https://d3codex.com/api/topics/cfunctions/cp-readv.json"},{"slug":"cfunctions/cp-release","title":"_CP_release","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_release is equivalent to the release expression,string BASIC statement.","url":"https://d3codex.com/cfunctions/cp-release/","api":"https://d3codex.com/api/topics/cfunctions/cp-release.json"},{"slug":"cfunctions/cp-release-all","title":"_CP_release_all","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_release_all is equivalent to the release BASIC statement.","url":"https://d3codex.com/cfunctions/cp-release-all/","api":"https://d3codex.com/api/topics/cfunctions/cp-release-all.json"},{"slug":"cfunctions/cp-replace","title":"_CP_replace","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_replace is equivalent to the result = replace(string1, ac.expression, vc.expression, sc.expression, string2) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-replace/","api":"https://d3codex.com/api/topics/cfunctions/cp-replace.json"},{"slug":"cfunctions/cp-replace-bridge","title":"_CP_replace_bridge","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_replace_bridge is equivalent to the replace expression,string1 with string2 BASIC statement.","url":"https://d3codex.com/cfunctions/cp-replace-bridge/","api":"https://d3codex.com/api/topics/cfunctions/cp-replace-bridge.json"},{"slug":"cfunctions/cp-rewind","title":"_CP_rewind","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_rewind is equivalent to the rewind BASIC statement.","url":"https://d3codex.com/cfunctions/cp-rewind/","api":"https://d3codex.com/api/topics/cfunctions/cp-rewind.json"},{"slug":"cfunctions/cp-root","title":"_CP_root","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_root is equivalent to the root string1, string2 to result BASIC statement.","url":"https://d3codex.com/cfunctions/cp-root/","api":"https://d3codex.com/api/topics/cfunctions/cp-root.json"},{"slug":"cfunctions/cp-rs","title":"_CP_rs_","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_rs converts a double floating point number into a CPSTR. The precision of this function can be changed using the _CP_precision function.","url":"https://d3codex.com/cfunctions/cp-rs/","api":"https://d3codex.com/api/topics/cfunctions/cp-rs.json"},{"slug":"cfunctions/cp-saddr","title":"_CP_SADDR","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_SADDR returns a standard char* pointing to the first character of the string buffer within a CPSTR structure. Because _CP_SADDR is a macro, it can be used either to the left or right side of an assignment operator.","url":"https://d3codex.com/cfunctions/cp-saddr/","api":"https://d3codex.com/api/topics/cfunctions/cp-saddr.json"},{"slug":"cfunctions/cp-select","title":"_CP_select","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_select is equivalent to the select expression1 to list BASIC statement.","url":"https://d3codex.com/cfunctions/cp-select/","api":"https://d3codex.com/api/topics/cfunctions/cp-select.json"},{"slug":"cfunctions/cp-send","title":"_CP_send","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_send is equivalent to the send{x} string{:} to port.number BASIC statement.","url":"https://d3codex.com/cfunctions/cp-send/","api":"https://d3codex.com/api/topics/cfunctions/cp-send.json"},{"slug":"cfunctions/cp-si","title":"_CP_si_","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_si_ converts a CPSTR into an integer.","url":"https://d3codex.com/cfunctions/cp-si/","api":"https://d3codex.com/api/topics/cfunctions/cp-si.json"},{"slug":"cfunctions/cp-sleep","title":"_CP_sleep","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_sleep is equivalent to the sleep(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-sleep/","api":"https://d3codex.com/api/topics/cfunctions/cp-sleep.json"},{"slug":"cfunctions/cp-slen","title":"_CP_SLEN","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_SLEN returns the length of the CPSTR*, string.","url":"https://d3codex.com/cfunctions/cp-slen/","api":"https://d3codex.com/api/topics/cfunctions/cp-slen.json"},{"slug":"cfunctions/cp-sort","title":"_CP_sort","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_sort is equivalent to the result = sort(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-sort/","api":"https://d3codex.com/api/topics/cfunctions/cp-sort.json"},{"slug":"cfunctions/cp-soundex","title":"_CP_soundex","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_soundex is equivalent to the result = soundex(string, type) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-soundex/","api":"https://d3codex.com/api/topics/cfunctions/cp-soundex.json"},{"slug":"cfunctions/cp-space","title":"_CP_space","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_space is equivalent to the result = space(expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-space/","api":"https://d3codex.com/api/topics/cfunctions/cp-space.json"},{"slug":"cfunctions/cp-sr","title":"_CP_sr_","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_sr_ converts a CPSTR into a double-float number. The precision of the conversion can be changed with the _CP_precision() function.","url":"https://d3codex.com/cfunctions/cp-sr/","api":"https://d3codex.com/api/topics/cfunctions/cp-sr.json"},{"slug":"cfunctions/cp-str","title":"_CP_str","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_str is equivalent to the result = str(string, expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-str/","api":"https://d3codex.com/api/topics/cfunctions/cp-str.json"},{"slug":"cfunctions/cp-str-alloc","title":"_CP_str_alloc","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_str_alloc allocates space for a CPSTR. It is the equivalent of malloc(), but returns a CPSTR*. The expression should contain the length of the string buffer to allocate. A 0 is returned if a failure occurs.","url":"https://d3codex.com/cfunctions/cp-str-alloc/","api":"https://d3codex.com/api/topics/cfunctions/cp-str-alloc.json"},{"slug":"cfunctions/cp-str-copy","title":"_CP_str_copy","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_str_copy makes a copy of a CPSTR. The actual contents of the string are copied rather than just the pointer.","url":"https://d3codex.com/cfunctions/cp-str-copy/","api":"https://d3codex.com/api/topics/cfunctions/cp-str-copy.json"},{"slug":"cfunctions/cp-str-free","title":"_CP_str_free","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_str_free releases the CPSTR* string back to the string pool to be allocated at a later time. All CPSTR*s must eventually be released with _CP_str_free.","url":"https://d3codex.com/cfunctions/cp-str-free/","api":"https://d3codex.com/api/topics/cfunctions/cp-str-free.json"},{"slug":"cfunctions/cp-str-null","title":"_CP_str_null","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_str_null points to a null length string. It should be used for reading only, to initialize a pointer with a pointer to a null string.","url":"https://d3codex.com/cfunctions/cp-str-null/","api":"https://d3codex.com/api/topics/cfunctions/cp-str-null.json"},{"slug":"cfunctions/cp-str-realloc","title":"_CP_str_realloc","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_str_realloc reallocates a CPSTR* to a new length.","url":"https://d3codex.com/cfunctions/cp-str-realloc/","api":"https://d3codex.com/api/topics/cfunctions/cp-str-realloc.json"},{"slug":"cfunctions/cp-str0","title":"_CP_str0","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_str0 is a static CPSTR* that points to a single character string that contains 0. It should be used for reading only.","url":"https://d3codex.com/cfunctions/cp-str0/","api":"https://d3codex.com/api/topics/cfunctions/cp-str0.json"},{"slug":"cfunctions/cp-substr","title":"_CP_substr","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_substr is equivalent to the result = string[beg.pos.expression, len.expression] BASIC statement.","url":"https://d3codex.com/cfunctions/cp-substr/","api":"https://d3codex.com/api/topics/cfunctions/cp-substr.json"},{"slug":"cfunctions/cp-sum","title":"_CP_sum","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_sum is equivalent to the result = sum(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-sum/","api":"https://d3codex.com/api/topics/cfunctions/cp-sum.json"},{"slug":"cfunctions/cp-system","title":"_CP_system","category":"C Functions","categorySlug":"cfunctions","summary":"The _CP_system function is equivalent to the result = system(expression) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-system/","api":"https://d3codex.com/api/topics/cfunctions/cp-system.json"},{"slug":"cfunctions/cp-term","title":"_CP_TERM","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_TERM terminates a CPSTR* string with a null character.","url":"https://d3codex.com/cfunctions/cp-term/","api":"https://d3codex.com/api/topics/cfunctions/cp-term.json"},{"slug":"cfunctions/cp-time","title":"_CP_time","category":"C Functions","categorySlug":"cfunctions","summary":"The _CP_time function is equivalent to the result = time() BASIC statement.","url":"https://d3codex.com/cfunctions/cp-time/","api":"https://d3codex.com/api/topics/cfunctions/cp-time.json"},{"slug":"cfunctions/cp-timedate","title":"_CP_timedate","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_timedate is equivalent to the result = timedate() BASIC statement.","url":"https://d3codex.com/cfunctions/cp-timedate/","api":"https://d3codex.com/api/topics/cfunctions/cp-timedate.json"},{"slug":"cfunctions/cp-trans","title":"_CP_trans","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_trans is equivalent to one of several BASIC transaction processing statements depending on the op parameter. Valid values of op are:","url":"https://d3codex.com/cfunctions/cp-trans/","api":"https://d3codex.com/api/topics/cfunctions/cp-trans.json"},{"slug":"cfunctions/cp-trim","title":"_CP_trim","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_trim is equivalent to the result = trim(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-trim/","api":"https://d3codex.com/api/topics/cfunctions/cp-trim.json"},{"slug":"cfunctions/cp-unix-break","title":"_CP_unix_break","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_unix_break causes all subsequent breaks to terminate the process as is standard in UNIX applications.","url":"https://d3codex.com/cfunctions/cp-unix-break/","api":"https://d3codex.com/api/topics/cfunctions/cp-unix-break.json"},{"slug":"cfunctions/cp-unix-env","title":"_CP_unix_env","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_unix_env sets the application to a standard UNIX environment. When using this setting, all terminal input and output must be done via standard UNIX routines only (system, printf, scanf).","url":"https://d3codex.com/cfunctions/cp-unix-env/","api":"https://d3codex.com/api/topics/cfunctions/cp-unix-env.json"},{"slug":"cfunctions/cp-unlock","title":"_CP_unlock","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_unlock is equivalent to the unlock expression BASIC statement.","url":"https://d3codex.com/cfunctions/cp-unlock/","api":"https://d3codex.com/api/topics/cfunctions/cp-unlock.json"},{"slug":"cfunctions/cp-unlock-all","title":"_CP_unlock_all","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_unlock_all is equivalent to the unlock BASIC statement.","url":"https://d3codex.com/cfunctions/cp-unlock-all/","api":"https://d3codex.com/api/topics/cfunctions/cp-unlock-all.json"},{"slug":"cfunctions/cp-weof","title":"_CP_weof","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_weof is equivalent to the weof BASIC statement.","url":"https://d3codex.com/cfunctions/cp-weof/","api":"https://d3codex.com/api/topics/cfunctions/cp-weof.json"},{"slug":"cfunctions/cp-write","title":"_CP_write","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_write is equivalent to the write or writeu BASIC statements.","url":"https://d3codex.com/cfunctions/cp-write/","api":"https://d3codex.com/api/topics/cfunctions/cp-write.json"},{"slug":"cfunctions/cp-writefields","title":"_CP_writefields","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_writefields supports writing a set of named fields.","url":"https://d3codex.com/cfunctions/cp-writefields/","api":"https://d3codex.com/api/topics/cfunctions/cp-writefields.json"},{"slug":"cfunctions/cp-writet","title":"_CP_writet","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_writet is equivalent to the writet BASIC statement.","url":"https://d3codex.com/cfunctions/cp-writet/","api":"https://d3codex.com/api/topics/cfunctions/cp-writet.json"},{"slug":"cfunctions/cp-writev","title":"_CP_writev","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_writev is equivalent to the writev and writevu BASIC statements.","url":"https://d3codex.com/cfunctions/cp-writev/","api":"https://d3codex.com/api/topics/cfunctions/cp-writev.json"},{"slug":"cfunctions/cp-xtd","title":"_CP_xtd","category":"C Functions","categorySlug":"cfunctions","summary":"_CP_xtd is equivalent to the result = xtd(string) BASIC statement.","url":"https://d3codex.com/cfunctions/cp-xtd/","api":"https://d3codex.com/api/topics/cfunctions/cp-xtd.json"},{"slug":"cfunctions/cpstr","title":"CPSTR","category":"C Functions","categorySlug":"cfunctions","summary":"CPSTR defines the structure of a D3 data element manipulated from the C environment.","url":"https://d3codex.com/cfunctions/cpstr/","api":"https://d3codex.com/api/topics/cfunctions/cpstr.json"},{"slug":"cfunctions/cpstr-asterisk","title":"CPSTR*","category":"C Functions","categorySlug":"cfunctions","summary":"CPSTR* points to a string structure used by routines that access D3 from the C programming language.","url":"https://d3codex.com/cfunctions/cpstr-asterisk/","api":"https://d3codex.com/api/topics/cfunctions/cpstr-asterisk.json"},{"slug":"cfunctions/custom-signal-processing","title":"Custom signal processing","category":"C Functions","categorySlug":"cfunctions","summary":"The D3 libraries make extensive use of signal processing. Because of this, the practice of reprogramming signals within a C application using D3 C routines is strongly discouraged. However, if it is absolutely necessary, there are several rules which must be followed.","url":"https://d3codex.com/cfunctions/custom-signal-processing/","api":"https://d3codex.com/api/topics/cfunctions/custom-signal-processing.json"},{"slug":"cfunctions/environment-setting","title":"Environment setting","category":"C Functions","categorySlug":"cfunctions","summary":"To make it easier to handle the differences between the standard behavior of UNIX programs and the standard behavior of D3 programs, two calls are provided that set the environment to either D3 or UNIX.","url":"https://d3codex.com/cfunctions/environment-setting/","api":"https://d3codex.com/api/topics/cfunctions/environment-setting.json"},{"slug":"cfunctions/general-usage","title":"General usage","category":"C Functions","categorySlug":"cfunctions","summary":"To use this library, the user makes a call to _CP_logon() at the beginning of the C program to connect to the D3 virtual machine. This call goes through the normal D3 logon activities, but suppresses all user prompts and messages. Note that neither the user nor the MD macro will be executed. After logging on, the user has full access to the D3 database using C calls that provide functionality previously available only through FlashBASIC. When the C program completes, the user must issue a _CP_logoff() call to terminate the D3 connection.","url":"https://d3codex.com/cfunctions/general-usage/","api":"https://d3codex.com/api/topics/cfunctions/general-usage.json"},{"slug":"cfunctions/handling-general-d3-interrupts","title":"Handling general D3 interrupts","category":"C Functions","categorySlug":"cfunctions","summary":"D3 interrupts, besides breaks such as messages, can not be masked, but can be detected (after the occurrence) by interrogating the _CP_interrupt variable. This integer location contains the same information available in BASIC from the system(37) function. However, an examination of _CP_interrupt is much more efficient when programming in C.","url":"https://d3codex.com/cfunctions/handling-general-d3-interrupts/","api":"https://d3codex.com/api/topics/cfunctions/handling-general-d3-interrupts.json"},{"slug":"cfunctions/library-format","title":"Library format","category":"C Functions","categorySlug":"cfunctions","summary":"Functions within the library have the general structure:","url":"https://d3codex.com/cfunctions/library-format/","api":"https://d3codex.com/api/topics/cfunctions/library-format.json"},{"slug":"cfunctions/string-handling","title":"String handling","category":"C Functions","categorySlug":"cfunctions","summary":"The standard C string type is not sufficient for handling the dynamic nature of D3 strings, so a hybrid data type has been created called CPSTR. This data type provides allocation, deallocation, and resizing of strings at a much higher performance level than that obtained using malloc() and free() with C strings.","url":"https://d3codex.com/cfunctions/string-handling/","api":"https://d3codex.com/api/topics/cfunctions/string-handling.json"},{"slug":"definitions/abs","title":"ABS","category":"Definitions","categorySlug":"definitions","summary":"Absolute frames. These frames do not change, since no data is stored within them. The ABS area is where the D3 virtual (operating system) code resides.","url":"https://d3codex.com/definitions/abs/","api":"https://d3codex.com/api/topics/definitions/abs.json"},{"slug":"definitions/access-aql","title":"ACCESS (AQL)","category":"Definitions","categorySlug":"definitions","summary":"The ACCESS Query Language (AQL) is a D3 facility used to retrieve and output data and consists of the List preprocessor, the Select processor, and the Output processor. AQL is a system-level information retrieval language that allows users to query their database without writing complex programs.","url":"https://d3codex.com/definitions/access-aql/","api":"https://d3codex.com/api/topics/definitions/access-aql.json"},{"slug":"definitions/account-glossary","title":"Account","category":"Definitions","categorySlug":"definitions","summary":"An account is a collection of logically related files. Each account has a master dictionary (MD), where the vocabulary for the account resides. This includes items such as commands, Procs, menus, macros, connectives, modifiers, file-defining items (D-pointers) and synonym-defining items (Q-pointers).","url":"https://d3codex.com/definitions/account-glossary/","api":"https://d3codex.com/api/topics/definitions/account-glossary.json"},{"slug":"definitions/acid","title":"ACID","category":"Definitions","categorySlug":"definitions","summary":"ACID is an acronym for Atomic, Compliant, Isolated, Durable.","url":"https://d3codex.com/definitions/acid/","api":"https://d3codex.com/api/topics/definitions/acid.json"},{"slug":"definitions/active-list","title":"Active list","category":"Definitions","categorySlug":"definitions","summary":"An active list is a list of strings for use in a subsequent process that handles items one at a time. Typically, a list contains item-IDs for subsequent processing, but a list can actually contain anything. For example, the statement, select entity creates a list of item-IDs, while the statement, select entity name creates a list from the contents of each entity item’s name attribute.","url":"https://d3codex.com/definitions/active-list/","api":"https://d3codex.com/api/topics/definitions/active-list.json"},{"slug":"definitions/adi","title":"ADI","category":"Definitions","categorySlug":"definitions","summary":"ADI is an acronym for attribute-defining item.","url":"https://d3codex.com/definitions/adi/","api":"https://d3codex.com/api/topics/definitions/adi.json"},{"slug":"definitions/alias","title":"Alias","category":"Definitions","categorySlug":"definitions","summary":"Each server can be given an alias to avoid having to tie a D3 object to a given computer on the network. For example: When creating an accounting database, it is better to use an alias (such as Accounting) for the server name, rather than its physical network name.","url":"https://d3codex.com/definitions/alias/","api":"https://d3codex.com/api/topics/definitions/alias.json"},{"slug":"definitions/amc","title":"AMC","category":"Definitions","categorySlug":"definitions","summary":"AMC is an acronym for attribute mark count.","url":"https://d3codex.com/definitions/amc/","api":"https://d3codex.com/api/topics/definitions/amc.json"},{"slug":"definitions/ascii","title":"ASCII","category":"Definitions","categorySlug":"definitions","summary":"ASCII is an acronym for the set of characters that comprise the American Standard Code for Information Interchange.","url":"https://d3codex.com/definitions/ascii/","api":"https://d3codex.com/api/topics/definitions/ascii.json"},{"slug":"definitions/assembler","title":"Assembler","category":"Definitions","categorySlug":"definitions","summary":"The assembler changes Pick assembly language source statements (lines) into machine executable object code.","url":"https://d3codex.com/definitions/assembler/","api":"https://d3codex.com/api/topics/definitions/assembler.json"},{"slug":"definitions/assembly-language-pick","title":"Assembly language, Pick","category":"Definitions","categorySlug":"definitions","summary":"Pick assembly language defines the language of the Pick Virtual environment. It is used to write the Pick core functionalities.","url":"https://d3codex.com/definitions/assembly-language-pick/","api":"https://d3codex.com/api/topics/definitions/assembly-language-pick.json"},{"slug":"definitions/assembly-languages","title":"Assembly languages","category":"Definitions","categorySlug":"definitions","summary":"Assembly languages are computer programming languages usually related to particular CPU’s primitives.","url":"https://d3codex.com/definitions/assembly-languages/","api":"https://d3codex.com/api/topics/definitions/assembly-languages.json"},{"slug":"definitions/atomic-operation","title":"Atomic operation","category":"Definitions","categorySlug":"definitions","summary":"An atomic operation is an indivisible operation, either uninterruptible or, if aborted, a mechanism is provided that ensures the return of the system to its state prior to initiation of the operation.","url":"https://d3codex.com/definitions/atomic-operation/","api":"https://d3codex.com/api/topics/definitions/atomic-operation.json"},{"slug":"definitions/attribute","title":"Attribute","category":"Definitions","categorySlug":"definitions","summary":"An attribute is a field that is used to store data within an item.","url":"https://d3codex.com/definitions/attribute/","api":"https://d3codex.com/api/topics/definitions/attribute.json"},{"slug":"definitions/attribute-mark","title":"Attribute mark","category":"Definitions","categorySlug":"definitions","summary":"An attribute mark is the specific metacharacter used in D3 items to indicate the end of an attribute, and the beginning of another.","url":"https://d3codex.com/definitions/attribute-mark/","api":"https://d3codex.com/api/topics/definitions/attribute-mark.json"},{"slug":"definitions/b-tree","title":"B-tree","category":"Definitions","categorySlug":"definitions","summary":"B-tree is the balanced tree access method that D3 supports throughout the system and in every process that touches the database.","url":"https://d3codex.com/definitions/b-tree/","api":"https://d3codex.com/api/topics/definitions/b-tree.json"},{"slug":"definitions/backward-link-zero","title":"Backward link zero","category":"Definitions","categorySlug":"definitions","summary":"Backward link zero (BLZ) is a particular system error. A frame containing data, either workspace or file system data was not properly linked to a previous frame of data. Instead, this backward pointer was zero. The system was traversing data backward and ran off the beginning of the data.","url":"https://d3codex.com/definitions/backward-link-zero/","api":"https://d3codex.com/api/topics/definitions/backward-link-zero.json"},{"slug":"definitions/basic-glossary","title":"BASIC (glossary)","category":"Definitions","categorySlug":"definitions","summary":"Beginners All Purpose Symbolic Instruction Code (BASIC) is a third generation programming language originally developed at Dartmouth College in the early sixties. COBOL and the various forms of BASIC taken as a whole are the two most popular programming languages of all time.","url":"https://d3codex.com/definitions/basic-glossary/","api":"https://d3codex.com/api/topics/definitions/basic-glossary.json"},{"slug":"definitions/binary-files-glossary","title":"Binary files (glossary)","category":"Definitions","categorySlug":"definitions","summary":"Binary files are used to access binary items using normal D3 utilities.","url":"https://d3codex.com/definitions/binary-files-glossary/","api":"https://d3codex.com/api/topics/definitions/binary-files-glossary.json"},{"slug":"definitions/blocked-i-o","title":"Blocked I/O","category":"Definitions","categorySlug":"definitions","summary":"Blocking I/O is the process that D3 uses to group several disk reads into one larger disk access in order to improve disk performance.","url":"https://d3codex.com/definitions/blocked-i-o/","api":"https://d3codex.com/api/topics/definitions/blocked-i-o.json"},{"slug":"definitions/blz","title":"BLZ","category":"Definitions","categorySlug":"definitions","summary":"BLZ is an acronym for backward link zero.","url":"https://d3codex.com/definitions/blz/","api":"https://d3codex.com/api/topics/definitions/blz.json"},{"slug":"definitions/branching","title":"Branching","category":"Definitions","categorySlug":"definitions","summary":"Branching is a fundamental concept in programming and programming languages regarding the control of program execution.","url":"https://d3codex.com/definitions/branching/","api":"https://d3codex.com/api/topics/definitions/branching.json"},{"slug":"definitions/ccb","title":"CCB","category":"Definitions","categorySlug":"definitions","summary":"CCB is an acronym for cursor control block.","url":"https://d3codex.com/definitions/ccb/","api":"https://d3codex.com/api/topics/definitions/ccb.json"},{"slug":"definitions/cds","title":"CDS","category":"Definitions","categorySlug":"definitions","summary":"CDS is an acronym for Cell Directory Service.","url":"https://d3codex.com/definitions/cds/","api":"https://d3codex.com/api/topics/definitions/cds.json"},{"slug":"definitions/clipboard","title":"Clipboard","category":"Definitions","categorySlug":"definitions","summary":"The clipboard is a temporary storage area where data can be placed from an application and later retrieved from the same or another application.","url":"https://d3codex.com/definitions/clipboard/","api":"https://d3codex.com/api/topics/definitions/clipboard.json"},{"slug":"definitions/command","title":"Command","category":"Definitions","categorySlug":"definitions","summary":"A command is a stored procedure that is inherent to one of the processors in D3.","url":"https://d3codex.com/definitions/command/","api":"https://d3codex.com/api/topics/definitions/command.json"},{"slug":"definitions/conversion","title":"Conversion","category":"Definitions","categorySlug":"definitions","summary":"Conversions are subroutines used to convert data to alternate formats. These are listed under Processing Codes.","url":"https://d3codex.com/definitions/conversion/","api":"https://d3codex.com/api/topics/definitions/conversion.json"},{"slug":"definitions/correlative","title":"Correlative","category":"Definitions","categorySlug":"definitions","summary":"Correlatives are used in attribute 8 of the dictionary item being processed by AQL or the Update processor.","url":"https://d3codex.com/definitions/correlative/","api":"https://d3codex.com/api/topics/definitions/correlative.json"},{"slug":"definitions/crt","title":"CRT","category":"Definitions","categorySlug":"definitions","summary":"CRT is an acronym for cathode ray tube, the display portion of almost all dumb terminals.","url":"https://d3codex.com/definitions/crt/","api":"https://d3codex.com/api/topics/definitions/crt.json"},{"slug":"definitions/cruising","title":"Cruising","category":"Definitions","categorySlug":"definitions","summary":"Cruising is the ability to scan forwards and backwards through items in a file.","url":"https://d3codex.com/definitions/cruising/","api":"https://d3codex.com/api/topics/definitions/cruising.json"},{"slug":"definitions/ctrl-key","title":"CTRL key","category":"Definitions","categorySlug":"definitions","summary":"The CTRL key is used to enter commands in the Update processor.","url":"https://d3codex.com/definitions/ctrl-key/","api":"https://d3codex.com/api/topics/definitions/ctrl-key.json"},{"slug":"definitions/cursor-control-block","title":"Cursor control block","category":"Definitions","categorySlug":"definitions","summary":"A cursor control block is a binary item that contains the codes and control strings pertinent to the terminal in question. Each system functions (@(-(n))) has its own array position, and the system cursor function searches this item for control strings such as clear-screen, clear to end of screen, and so on.","url":"https://d3codex.com/definitions/cursor-control-block/","api":"https://d3codex.com/api/topics/definitions/cursor-control-block.json"},{"slug":"definitions/d-pointer","title":"D-pointer","category":"Definitions","categorySlug":"definitions","summary":"A D-pointer is used to define a file’s location.","url":"https://d3codex.com/definitions/d-pointer/","api":"https://d3codex.com/api/topics/definitions/d-pointer.json"},{"slug":"definitions/delimiter","title":"Delimiter","category":"Definitions","categorySlug":"definitions","summary":"A delimiter delineates parts of a statement, command, or data.","url":"https://d3codex.com/definitions/delimiter/","api":"https://d3codex.com/api/topics/definitions/delimiter.json"},{"slug":"definitions/dialer","title":"Dialer","category":"Definitions","categorySlug":"definitions","summary":"The dialer is a subsystem that allows D3 systems to communicate over serial lines to transfer items, execute commands on remote sites, and to synchronize databases by transferring updates.","url":"https://d3codex.com/definitions/dialer/","api":"https://d3codex.com/api/topics/definitions/dialer.json"},{"slug":"definitions/dictionaries","title":"Dictionaries","category":"Definitions","categorySlug":"definitions","summary":"Dictionaries are used by the D3 system to describe, define, locate, and, in general, operate on data within the files to which they point.","url":"https://d3codex.com/definitions/dictionaries/","api":"https://d3codex.com/api/topics/definitions/dictionaries.json"},{"slug":"definitions/dirty-bits","title":"Dirty bits","category":"Definitions","categorySlug":"definitions","summary":"Dirty bits are status bytes associated with each item in the D3 file system indicating that the item is new or changed.","url":"https://d3codex.com/definitions/dirty-bits/","api":"https://d3codex.com/api/topics/definitions/dirty-bits.json"},{"slug":"definitions/dm","title":"dm","category":"Definitions","categorySlug":"definitions","summary":"dm is an acronym for the D3 data manager account which contains the files necessary for basic system operation.","url":"https://d3codex.com/definitions/dm/","api":"https://d3codex.com/api/topics/definitions/dm.json"},{"slug":"definitions/domain","title":"Domain","category":"Definitions","categorySlug":"definitions","summary":"A Windows concept that defines a set of systems, clients, and servers that are administered as a unit. A domain controller is designated to handle the security.","url":"https://d3codex.com/definitions/domain/","api":"https://d3codex.com/api/topics/definitions/domain.json"},{"slug":"definitions/double-space","title":"Double-space","category":"Definitions","categorySlug":"definitions","summary":"Double-spacing AQL reports can be achieved using the dbl-spc modifier. To double-space Output processor documents, change the vertical motion index by using the .vmi Output processor command.","url":"https://d3codex.com/definitions/double-space/","api":"https://d3codex.com/api/topics/definitions/double-space.json"},{"slug":"definitions/ebcdic","title":"EBCDIC","category":"Definitions","categorySlug":"definitions","summary":"EBCDIC is an acronym for Extended Binary Coded Decimal Interchange Code.","url":"https://d3codex.com/definitions/ebcdic/","api":"https://d3codex.com/api/topics/definitions/ebcdic.json"},{"slug":"definitions/element-data","title":"Element, data","category":"Definitions","categorySlug":"definitions","summary":"A data element is an atomic datum variously known as field, attribute, value, attribute value, and so on.","url":"https://d3codex.com/definitions/element-data/","api":"https://d3codex.com/api/topics/definitions/element-data.json"},{"slug":"definitions/entity","title":"Entity","category":"Definitions","categorySlug":"definitions","summary":"An entity is a system element, such as a D3 process, a serial port, or a device, with which data can be exchanged.","url":"https://d3codex.com/definitions/entity/","api":"https://d3codex.com/api/topics/definitions/entity.json"},{"slug":"definitions/expression","title":"Expression","category":"Definitions","categorySlug":"definitions","summary":"An expression is a variable, literal, function, or expression enclosed in parentheses, or a combination of these, separated by operators.","url":"https://d3codex.com/definitions/expression/","api":"https://d3codex.com/api/topics/definitions/expression.json"},{"slug":"definitions/external-format","title":"External format","category":"Definitions","categorySlug":"definitions","summary":"External format describes data that has been externally converted using one of the conversion or processing codes provided with D3. As a general rule, external format means data is in a human-readable format.","url":"https://d3codex.com/definitions/external-format/","api":"https://d3codex.com/api/topics/definitions/external-format.json"},{"slug":"definitions/fcb","title":"FCB","category":"Definitions","categorySlug":"definitions","summary":"FCB is an acronym for file control block.","url":"https://d3codex.com/definitions/fcb/","api":"https://d3codex.com/api/topics/definitions/fcb.json"},{"slug":"definitions/fdi","title":"FDI","category":"Definitions","categorySlug":"definitions","summary":"FDI is an acronym for file-defining item.","url":"https://d3codex.com/definitions/fdi/","api":"https://d3codex.com/api/topics/definitions/fdi.json"},{"slug":"definitions/fid","title":"FID","category":"Definitions","categorySlug":"definitions","summary":"FID is an acronym for frame-ID, which is the unique identifier to each virtual frame on the disk.","url":"https://d3codex.com/definitions/fid/","api":"https://d3codex.com/api/topics/definitions/fid.json"},{"slug":"definitions/file","title":"File","category":"Definitions","categorySlug":"definitions","summary":"Everything in the D3 database is an item in a file.","url":"https://d3codex.com/definitions/file/","api":"https://d3codex.com/api/topics/definitions/file.json"},{"slug":"definitions/file-control-block","title":"File control block","category":"Definitions","categorySlug":"definitions","summary":"Every file on the system has a special frame attached to it called a file control block or FCB. These frames contain information about the file, including index pointers and their compiled (algebraic) processing codes, the file D-pointer information for editing, pointers, and workspace used by the system when calling FlashBASIC subroutines from file dictionaries.","url":"https://d3codex.com/definitions/file-control-block/","api":"https://d3codex.com/api/topics/definitions/file-control-block.json"},{"slug":"definitions/file-defining-items","title":"File-defining items","category":"Definitions","categorySlug":"definitions","summary":"File-defining items are the mechanisms by which the D3 system establishes the disk addresses of a file.","url":"https://d3codex.com/definitions/file-defining-items/","api":"https://d3codex.com/api/topics/definitions/file-defining-items.json"},{"slug":"definitions/file-inconsistency","title":"File inconsistency","category":"Definitions","categorySlug":"definitions","summary":"A file inconsistency is a state representing structural inconsistency within a certain group of a file.","url":"https://d3codex.com/definitions/file-inconsistency/","api":"https://d3codex.com/api/topics/definitions/file-inconsistency.json"},{"slug":"definitions/file-inconsistency-handler","title":"File inconsistency handler","category":"Definitions","categorySlug":"definitions","summary":"The file inconsistency handler processes file inconsistencies encountered in the D3 file system.","url":"https://d3codex.com/definitions/file-inconsistency-handler/","api":"https://d3codex.com/api/topics/definitions/file-inconsistency-handler.json"},{"slug":"definitions/file-lock-codes","title":"File lock codes","category":"Definitions","categorySlug":"definitions","summary":"Attributes 5 and 6 of file-defining items can contain retrieval and update lock codes respectively. These codes are used to restrict access to certain data files and master dictionaries. Lock codes are sets of characters used as codes. Multiple lock codes are separated by value marks. The first lock code (retrieval or update) in a master dictionary or file dictionary must be matched in attribute 6 (key) of the user’s item in the users file to allow access to the file or master dictionary. If the lock code does not match, access is denied.","url":"https://d3codex.com/definitions/file-lock-codes/","api":"https://d3codex.com/api/topics/definitions/file-lock-codes.json"},{"slug":"definitions/file-name","title":"File name","category":"Definitions","categorySlug":"definitions","summary":"A file name is the name of a D3 file.","url":"https://d3codex.com/definitions/file-name/","api":"https://d3codex.com/api/topics/definitions/file-name.json"},{"slug":"definitions/file-reference","title":"File reference","category":"Definitions","categorySlug":"definitions","summary":"The file reference is the name of a file in the master dictionary to which the user is currently logged. It can also be a synonym file name. The file name can be preceded by the literal word dict to access the dictionary of the file instead of the data portion of the file. The default is data. In some cases, data may be specified to indicate only the data portion of the file.","url":"https://d3codex.com/definitions/file-reference/","api":"https://d3codex.com/api/topics/definitions/file-reference.json"},{"slug":"definitions/file-system-interface","title":"File System interface","category":"Definitions","categorySlug":"definitions","summary":"A D3 service, normally started automatically at boot time on a Windows server that services file system requests. Each D3 file server must have an FSI service or process started to be able to access the D3 tables.","url":"https://d3codex.com/definitions/file-system-interface/","api":"https://d3codex.com/api/topics/definitions/file-system-interface.json"},{"slug":"definitions/flashbasic","title":"FlashBASIC","category":"Definitions","categorySlug":"definitions","summary":"FlashBASIC is a high-level programming language that is an extension of the Dartmouth BASIC (Beginners All-purpose Symbolic Instruction Code) language. It is the principal programming language bundled with the D3 system and was designed for the implementation of application requirements not handled by standard D3 functionality.","url":"https://d3codex.com/definitions/flashbasic/","api":"https://d3codex.com/api/topics/definitions/flashbasic.json"},{"slug":"definitions/flusher","title":"Flusher","category":"Definitions","categorySlug":"definitions","summary":"The flusher is responsible for scheduling and writing all write-required (dirty) frames back to disk.","url":"https://d3codex.com/definitions/flusher/","api":"https://d3codex.com/api/topics/definitions/flusher.json"},{"slug":"definitions/font","title":"Font","category":"Definitions","categorySlug":"definitions","summary":"Font is the typeface of a character.","url":"https://d3codex.com/definitions/font/","api":"https://d3codex.com/api/topics/definitions/font.json"},{"slug":"definitions/frame","title":"Frame","category":"Definitions","categorySlug":"definitions","summary":"A frame is the basic storage area of the system. Each frame is addressed by its numeric frame ID (FID), beginning with frame 1, and ending at a frame called maxfid. Maxfid is determined by the actual size of the disk and the size of data frames.","url":"https://d3codex.com/definitions/frame/","api":"https://d3codex.com/api/topics/definitions/frame.json"},{"slug":"definitions/full-duplex","title":"Full duplex","category":"Definitions","categorySlug":"definitions","summary":"Full duplex means simultaneous bidirectional communications. Both sides send and receive with virtually no turnaround time.","url":"https://d3codex.com/definitions/full-duplex/","api":"https://d3codex.com/api/topics/definitions/full-duplex.json"},{"slug":"definitions/full-restore","title":"Full restore","category":"Definitions","categorySlug":"definitions","summary":"A full restore is the opposite of a full save or file-save. A full restore is the process of reloading the entire file system from either a file-save tape or from the original sys-gen media provided with your system.","url":"https://d3codex.com/definitions/full-restore/","api":"https://d3codex.com/api/topics/definitions/full-restore.json"},{"slug":"definitions/glossary","title":"Glossary","category":"Definitions","categorySlug":"definitions","summary":"Glossary of D3 terms, commands, acronyms, and so on.","url":"https://d3codex.com/definitions/glossary/","api":"https://d3codex.com/api/topics/definitions/glossary.json"},{"slug":"definitions/group","title":"Group","category":"Definitions","categorySlug":"definitions","summary":"A group is a partition in a file consisting of one or more linked frames used for storing and retrieving items.","url":"https://d3codex.com/definitions/group/","api":"https://d3codex.com/api/topics/definitions/group.json"},{"slug":"definitions/half-duplex","title":"Half duplex","category":"Definitions","categorySlug":"definitions","summary":"Half duplex is communication in a single direction at a time.","url":"https://d3codex.com/definitions/half-duplex/","api":"https://d3codex.com/api/topics/definitions/half-duplex.json"},{"slug":"definitions/hangup","title":"Hangup","category":"Definitions","categorySlug":"definitions","summary":"A hangup is a condition by which a device, usually a modem or a network, indicates to the application that communication is no longer possible.","url":"https://d3codex.com/definitions/hangup/","api":"https://d3codex.com/api/topics/definitions/hangup.json"},{"slug":"definitions/hashing","title":"Hashing","category":"Definitions","categorySlug":"definitions","summary":"Hashing is the file-access method used by D3 to find items in a file.","url":"https://d3codex.com/definitions/hashing/","api":"https://d3codex.com/api/topics/definitions/hashing.json"},{"slug":"definitions/header-files","title":"Header files","category":"Definitions","categorySlug":"definitions","summary":"Header files access header information using normal D3 utilities.","url":"https://d3codex.com/definitions/header-files/","api":"https://d3codex.com/api/topics/definitions/header-files.json"},{"slug":"definitions/hot-backup","title":"Hot backup","category":"Definitions","categorySlug":"definitions","summary":"Hot backup is a configuration where one machine is in a standby mode, ready to take over the load from a failing system. Starting with D3 9.0, hot backup now tests to confirm that a license has been purchased.","url":"https://d3codex.com/definitions/hot-backup/","api":"https://d3codex.com/api/topics/definitions/hot-backup.json"},{"slug":"definitions/hung-port","title":"Hung port","category":"Definitions","categorySlug":"definitions","summary":"A port is considered hung when it refuses to accept keyboard input and is producing no new terminal output.","url":"https://d3codex.com/definitions/hung-port/","api":"https://d3codex.com/api/topics/definitions/hung-port.json"},{"slug":"definitions/incremental-restore","title":"Incremental restore","category":"Definitions","categorySlug":"definitions","summary":"An incremental restore restores all items from the most recent incremental save tape.","url":"https://d3codex.com/definitions/incremental-restore/","api":"https://d3codex.com/api/topics/definitions/incremental-restore.json"},{"slug":"definitions/incremental-save","title":"Incremental save","category":"Definitions","categorySlug":"definitions","summary":"An incremental save backs up only the items that have been changed since the last full save.","url":"https://d3codex.com/definitions/incremental-save/","api":"https://d3codex.com/api/topics/definitions/incremental-save.json"},{"slug":"definitions/installation","title":"Installation","category":"Definitions","categorySlug":"definitions","summary":"Installation information is provided in your System Installation Guide provided with your D3 system.","url":"https://d3codex.com/definitions/installation/","api":"https://d3codex.com/api/topics/definitions/installation.json"},{"slug":"definitions/internal-format","title":"Internal format","category":"Definitions","categorySlug":"definitions","summary":"Internal format is the data format resulting when data is internally converted using one of the conversion or processing codes provided with D3. As a general rule, internal format refers to the manner in which data is stored inside the system.","url":"https://d3codex.com/definitions/internal-format/","api":"https://d3codex.com/api/topics/definitions/internal-format.json"},{"slug":"definitions/item","title":"Item","category":"Definitions","categorySlug":"definitions","summary":"An item is the fundamental directly accessible aggregation of data in D3.","url":"https://d3codex.com/definitions/item/","api":"https://d3codex.com/api/topics/definitions/item.json"},{"slug":"definitions/item-id-glossary","title":"Item-ID","category":"Definitions","categorySlug":"definitions","summary":"An item-ID is a unique identifier by which an item can be retrieved from a file. An item-ID may be any length up to 100 characters. It can be made up of any characters except the system delimiters; sm, am, vm, svm, or sb, and any character with an ASCII value 247 or greater. If any of these reserved values are used in an item-ID, the item-ID will be truncated at the first use of such a character. It is recommended that characters with ASCII values greater than 127 not be used since they may not display or show as different symbols on different display or printing devices.","url":"https://d3codex.com/definitions/item-id-glossary/","api":"https://d3codex.com/api/topics/definitions/item-id-glossary.json"},{"slug":"definitions/language-definition","title":"Language definition","category":"Definitions","categorySlug":"definitions","summary":"Language definition is the file structure that is used by D3 to perform case insensitive compares according to other language definitions.","url":"https://d3codex.com/definitions/language-definition/","api":"https://d3codex.com/api/topics/definitions/language-definition.json"},{"slug":"definitions/levels","title":"Levels","category":"Definitions","categorySlug":"definitions","summary":"Any command or program can be interrupted during execution by pressing the active level pushing key, (usually the BREAK or ESC key). When a command or program is interrupted, the system stops execution and saves all parameters so that execution can be resumed exactly where it was interrupted. When a process is interrupted at the normal system level, the system prompts with two colons. At this point the command or program is said to be pushed one level.","url":"https://d3codex.com/definitions/levels/","api":"https://d3codex.com/api/topics/definitions/levels.json"},{"slug":"definitions/linked-overflow","title":"Linked overflow","category":"Definitions","categorySlug":"definitions","summary":"Linked or dynamic overflow are the additional frames attached to a file. As files expand and contract, additional frames are added to or removed from the groups in the primary file space. All of these extra frames are called linked or dynamic overflow and the number of frames is always changing.","url":"https://d3codex.com/definitions/linked-overflow/","api":"https://d3codex.com/api/topics/definitions/linked-overflow.json"},{"slug":"definitions/locking-scheme","title":"Locking scheme","category":"Definitions","categorySlug":"definitions","summary":"D3 locks groups on a process basis. A port executing a program is locked from accessing items locked by the previous level.","url":"https://d3codex.com/definitions/locking-scheme/","api":"https://d3codex.com/api/topics/definitions/locking-scheme.json"},{"slug":"definitions/locks-glossary","title":"Locks","category":"Definitions","categorySlug":"definitions","summary":"See Retrieval and Update Locks.","url":"https://d3codex.com/definitions/locks-glossary/","api":"https://d3codex.com/api/topics/definitions/locks-glossary.json"},{"slug":"definitions/logon","title":"Logon","category":"Definitions","categorySlug":"definitions","summary":"The logon procedure is used to gain access to the system, and consists of a user prompt, which is usually:","url":"https://d3codex.com/definitions/logon/","api":"https://d3codex.com/api/topics/definitions/logon.json"},{"slug":"definitions/macros-glossary","title":"Macros","category":"Definitions","categorySlug":"definitions","summary":"Macros are used to execute one or more TCL commands and are stored in the master dictionary with the name of the macro as the item-ID.","url":"https://d3codex.com/definitions/macros-glossary/","api":"https://d3codex.com/api/topics/definitions/macros-glossary.json"},{"slug":"definitions/master-dictionary","title":"Master dictionary","category":"Definitions","categorySlug":"definitions","summary":"The master dictionary (md) file contains commands, Procs, macros, menus, connectives, default attribute-defining items, and file-defining items [both local (D-pointers) and synonym (Q-pointers)].","url":"https://d3codex.com/definitions/master-dictionary/","api":"https://d3codex.com/api/topics/definitions/master-dictionary.json"},{"slug":"definitions/maxfid","title":"Maxfid","category":"Definitions","categorySlug":"definitions","summary":"The maxfid is the last addressable frame on the disk. The what command outputs the current maxfid.","url":"https://d3codex.com/definitions/maxfid/","api":"https://d3codex.com/api/topics/definitions/maxfid.json"},{"slug":"definitions/menus-glossary","title":"Menus","category":"Definitions","categorySlug":"definitions","summary":"Menus provide a selection of processing choices.","url":"https://d3codex.com/definitions/menus-glossary/","api":"https://d3codex.com/api/topics/definitions/menus-glossary.json"},{"slug":"definitions/metacharacters","title":"Metacharacters","category":"Definitions","categorySlug":"definitions","summary":"Metacharacters are used to reference one of the four reserved delimiters that D3 uses within its item structure.","url":"https://d3codex.com/definitions/metacharacters/","api":"https://d3codex.com/api/topics/definitions/metacharacters.json"},{"slug":"definitions/modulo-glossary","title":"Modulo","category":"Definitions","categorySlug":"definitions","summary":"A modulo designates the number of groups (measured in frames) in the primary file space, as indicated during the creation or reallocation of the file.","url":"https://d3codex.com/definitions/modulo-glossary/","api":"https://d3codex.com/api/topics/definitions/modulo-glossary.json"},{"slug":"definitions/name-service","title":"Name service","category":"Definitions","categorySlug":"definitions","summary":"The Name service allows clients to locate the service they need without knowing where and how to reach the server providing the service. To perform this service, Name service hides the network location and network protocols behind a symbolic service identification. This mechanism makes the application independent from the details, allowing, for example, for redistributing the server application from one system to another without any change in the client applications.","url":"https://d3codex.com/definitions/name-service/","api":"https://d3codex.com/api/topics/definitions/name-service.json"},{"slug":"definitions/network-save-restore","title":"Network save/restore","category":"Definitions","categorySlug":"definitions","summary":"This topic describes how to implement a full save/restore of one machine to another across a network, using tape-socket.","url":"https://d3codex.com/definitions/network-save-restore/","api":"https://d3codex.com/api/topics/definitions/network-save-restore.json"},{"slug":"definitions/open-systems-file-interface","title":"Open Systems File interface","category":"Definitions","categorySlug":"definitions","summary":"The Open Systems File interface (OSFI) provides a standard mechanism for handling nonfile entities as if they were standard D3 files.","url":"https://d3codex.com/definitions/open-systems-file-interface/","api":"https://d3codex.com/api/topics/definitions/open-systems-file-interface.json"},{"slug":"definitions/osfi","title":"OSFI","category":"Definitions","categorySlug":"definitions","summary":"An acronym for the Open Systems File interface","url":"https://d3codex.com/definitions/osfi/","api":"https://d3codex.com/api/topics/definitions/osfi.json"},{"slug":"definitions/overflow-table","title":"Overflow table","category":"Definitions","categorySlug":"definitions","summary":"The overflow table is the area that contains a list of unused frames.","url":"https://d3codex.com/definitions/overflow-table/","api":"https://d3codex.com/api/topics/definitions/overflow-table.json"},{"slug":"definitions/passwords","title":"Passwords","category":"Definitions","categorySlug":"definitions","summary":"Account passwords can be used to limit the access to an account or to limit access to the system.","url":"https://d3codex.com/definitions/passwords/","api":"https://d3codex.com/api/topics/definitions/passwords.json"},{"slug":"definitions/performance-monitoring","title":"Performance monitoring","category":"Definitions","categorySlug":"definitions","summary":"Performance monitoring is the process of using various tips, utilities, and performance monitoring tools that allow identifying possible bottlenecks in a given configuration.","url":"https://d3codex.com/definitions/performance-monitoring/","api":"https://d3codex.com/api/topics/definitions/performance-monitoring.json"},{"slug":"definitions/phantom-process","title":"Phantom process","category":"Definitions","categorySlug":"definitions","summary":"A phantom process is a process that is initiated at a terminal and detaches itself from that terminal for execution independent of that terminal. It is processed as a background task and the results display on the initiating terminal when the process is complete.","url":"https://d3codex.com/definitions/phantom-process/","api":"https://d3codex.com/api/topics/definitions/phantom-process.json"},{"slug":"definitions/pib","title":"PIB","category":"Definitions","categorySlug":"definitions","summary":"PIB is an acronym for Process Identification Block. It is often used, inappropriately, to designate a D3 port number.","url":"https://d3codex.com/definitions/pib/","api":"https://d3codex.com/api/topics/definitions/pib.json"},{"slug":"definitions/pib-status","title":"PIB status","category":"Definitions","categorySlug":"definitions","summary":"PIB status is a piece of data returned by the where command. The pibstat program is used to break the information down into the possible binary states.","url":"https://d3codex.com/definitions/pib-status/","api":"https://d3codex.com/api/topics/definitions/pib-status.json"},{"slug":"definitions/pick-remote-files","title":"Pick remote files","category":"Definitions","categorySlug":"definitions","summary":"Pick remote files are standard Pick files on a nonlocal Pick machine.","url":"https://d3codex.com/definitions/pick-remote-files/","api":"https://d3codex.com/api/topics/definitions/pick-remote-files.json"},{"slug":"definitions/pid","title":"PID","category":"Definitions","categorySlug":"definitions","summary":"A Process ID (PID) uniquely identifies a UNIX process. On D3, each D3 process is a UNIX process, and, therefore, is assigned a PID by UNIX. D3 processes are usually identified by their D3 port number (from 0 to the maximum number of ports), as usual. It is sometimes necessary to identify the PID of a D3 process. The PIDs are displayed by the TCL commands list-users, pid, psr and by the UNIX command d3.","url":"https://d3codex.com/definitions/pid/","api":"https://d3codex.com/api/topics/definitions/pid.json"},{"slug":"definitions/pointer-item","title":"Pointer item","category":"Definitions","categorySlug":"definitions","summary":"Pointer items are internal file place-keepers that point to the frame where the actual data resides.","url":"https://d3codex.com/definitions/pointer-item/","api":"https://d3codex.com/api/topics/definitions/pointer-item.json"},{"slug":"definitions/port","title":"Port","category":"Definitions","categorySlug":"definitions","summary":"For UNIX: Port is not always the same as the physical device, and can be thought of as the D3 port number.","url":"https://d3codex.com/definitions/port/","api":"https://d3codex.com/api/topics/definitions/port.json"},{"slug":"definitions/port-number","title":"Port number","category":"Definitions","categorySlug":"definitions","summary":"A port number is the sequentially-assigned number associated with each physical line or process on the system. The number of ports is determined by issuing the where command with a z option.","url":"https://d3codex.com/definitions/port-number/","api":"https://d3codex.com/api/topics/definitions/port-number.json"},{"slug":"definitions/primary-file-space","title":"Primary file space","category":"Definitions","categorySlug":"definitions","summary":"Primary file space is the initial space set aside for a file and is specified as a number of frames in the create-file command. For instance, if a file data level is set aside using 11 frames as its modulo, it has 11 frames in its primary file space.","url":"https://d3codex.com/definitions/primary-file-space/","api":"https://d3codex.com/api/topics/definitions/primary-file-space.json"},{"slug":"definitions/primary-list","title":"Primary list","category":"Definitions","categorySlug":"definitions","summary":"A primary list is an active list of item-IDs to be used in a subsequent process that processes them one at a time.","url":"https://d3codex.com/definitions/primary-list/","api":"https://d3codex.com/api/topics/definitions/primary-list.json"},{"slug":"definitions/prompt","title":"Prompt","category":"Definitions","categorySlug":"definitions","summary":"A prompt is a computer request for data entry.","url":"https://d3codex.com/definitions/prompt/","api":"https://d3codex.com/api/topics/definitions/prompt.json"},{"slug":"definitions/prompt-characters","title":"Prompt characters","category":"Definitions","categorySlug":"definitions","summary":"Prompt characters are the characters displayed at input prompts. The number of prompt characters output is equivalent to the level a process is at.","url":"https://d3codex.com/definitions/prompt-characters/","api":"https://d3codex.com/api/topics/definitions/prompt-characters.json"},{"slug":"definitions/pseudo-tape","title":"Pseudo tape","category":"Definitions","categorySlug":"definitions","summary":"A pseudo tape is a binary host file handled internally as a large floppy. Data is formatted in 512 byte sectors and accessed sequentially.","url":"https://d3codex.com/definitions/pseudo-tape/","api":"https://d3codex.com/api/topics/definitions/pseudo-tape.json"},{"slug":"definitions/q-pointer","title":"Q-pointer","category":"Definitions","categorySlug":"definitions","summary":"A Q-pointer defines a duplicate (synonym) name for an already existing file.","url":"https://d3codex.com/definitions/q-pointer/","api":"https://d3codex.com/api/topics/definitions/q-pointer.json"},{"slug":"definitions/qs-pointer","title":"QS-pointer","category":"Definitions","categorySlug":"definitions","summary":"A QS-pointer defines a remote file that is saved as if it were local.","url":"https://d3codex.com/definitions/qs-pointer/","api":"https://d3codex.com/api/topics/definitions/qs-pointer.json"},{"slug":"definitions/restore","title":"Restore","category":"Definitions","categorySlug":"definitions","summary":"A restore refers to the loading (restoring) of data into the D3 file system from a backup media created by a save, or t-dump.","url":"https://d3codex.com/definitions/restore/","api":"https://d3codex.com/api/topics/definitions/restore.json"},{"slug":"definitions/restricted-system-access","title":"Restricted system access","category":"Definitions","categorySlug":"definitions","summary":"Restricted system access means that a user has been denied access to TCL. Users can be denied access to TCL by placing the character r in the options attribute (Attribute 9: Attribute type) of their item in the users file. When this restriction is active, users are returned to the system logon program when they exit a process by pressing the BREAK key, if it is enabled.","url":"https://d3codex.com/definitions/restricted-system-access/","api":"https://d3codex.com/api/topics/definitions/restricted-system-access.json"},{"slug":"definitions/retrieval-and-update-locks","title":"Retrieval and update locks","category":"Definitions","categorySlug":"definitions","summary":"If any process, such as a TCL command or a FlashBASIC program is executed from an account that does not have retrieval and/or update privileges for a file, and then attempts to read and/or write to that file, the process terminates with an error message indicating that the file is access protected.","url":"https://d3codex.com/definitions/retrieval-and-update-locks/","api":"https://d3codex.com/api/topics/definitions/retrieval-and-update-locks.json"},{"slug":"definitions/scrubber","title":"Scrubber","category":"Definitions","categorySlug":"definitions","summary":"A scrubber is a mechanism that provides overflow protection in the event of a system halt.","url":"https://d3codex.com/definitions/scrubber/","api":"https://d3codex.com/api/topics/definitions/scrubber.json"},{"slug":"definitions/secondary-list","title":"Secondary list","category":"Definitions","categorySlug":"definitions","summary":"Secondary lists are created using the s option with the select, sselect or get-list commands. Its is only used when running compare and copy commands.","url":"https://d3codex.com/definitions/secondary-list/","api":"https://d3codex.com/api/topics/definitions/secondary-list.json"},{"slug":"definitions/security","title":"Security","category":"Definitions","categorySlug":"definitions","summary":"D3 provides several levels of security, including:","url":"https://d3codex.com/definitions/security/","api":"https://d3codex.com/api/topics/definitions/security.json"},{"slug":"definitions/segment-mark","title":"Segment mark","category":"Definitions","categorySlug":"definitions","summary":"A segment mark is the specific metacharacter used within D3 items. The segment mark is not actually part of data. Rather, it is used as an item delimiter, and is automatically appended to the end of an item when written to disk.","url":"https://d3codex.com/definitions/segment-mark/","api":"https://d3codex.com/api/topics/definitions/segment-mark.json"},{"slug":"definitions/selection-processor","title":"Selection processor","category":"Definitions","categorySlug":"definitions","summary":"The selection processor is responsible for presenting items to the List processor based on processing the selection criteria.","url":"https://d3codex.com/definitions/selection-processor/","api":"https://d3codex.com/api/topics/definitions/selection-processor.json"},{"slug":"definitions/seq","title":"seq","category":"Definitions","categorySlug":"definitions","summary":"A seq item alters the normal sort sequence of characters used by the ms (mask alter sort) processing code.","url":"https://d3codex.com/definitions/seq/","api":"https://d3codex.com/api/topics/definitions/seq.json"},{"slug":"definitions/software-change-request","title":"Software change request","category":"Definitions","categorySlug":"definitions","summary":"Whenever requesting a software change, please provide as much of the following information to Rocket as you can. This form can be mailed or faxed to Rocket. Software Change Requests can also be phoned into Rocket.","url":"https://d3codex.com/definitions/software-change-request/","api":"https://d3codex.com/api/topics/definitions/software-change-request.json"},{"slug":"definitions/start-buffer-mark","title":"Start buffer mark","category":"Definitions","categorySlug":"definitions","summary":"The start buffer mark is used to pad tape records to the length specified during the most recently executed tape attachment command.","url":"https://d3codex.com/definitions/start-buffer-mark/","api":"https://d3codex.com/api/topics/definitions/start-buffer-mark.json"},{"slug":"definitions/subvalue","title":"Subvalue","category":"Definitions","categorySlug":"definitions","summary":"A subvalue is a field used to store data within a value of an attribute within an item.","url":"https://d3codex.com/definitions/subvalue/","api":"https://d3codex.com/api/topics/definitions/subvalue.json"},{"slug":"definitions/subvalue-mark","title":"Subvalue mark","category":"Definitions","categorySlug":"definitions","summary":"A subvalue mark is the specific metacharacter used within D3 items to indicate the end of a subvalue, and the beginning of another.","url":"https://d3codex.com/definitions/subvalue-mark/","api":"https://d3codex.com/api/topics/definitions/subvalue-mark.json"},{"slug":"definitions/super-q-pointer","title":"Super Q-pointer","category":"Definitions","categorySlug":"definitions","summary":"Super Q-pointers are extended Q-pointers used to access non-D3 and/or nonlocal files.","url":"https://d3codex.com/definitions/super-q-pointer/","api":"https://d3codex.com/api/topics/definitions/super-q-pointer.json"},{"slug":"definitions/synonym-defining-items","title":"Synonym-defining items","category":"Definitions","categorySlug":"definitions","summary":"Also known as Q-pointers, synonym-defining items are used in account master dictionaries to point to other files. A Q-pointer is a file alias that defines a path to an existing file that resides in the system under another name, or in another account, or both. A Q-pointer can reference any file in the system, including those within the same account.","url":"https://d3codex.com/definitions/synonym-defining-items/","api":"https://d3codex.com/api/topics/definitions/synonym-defining-items.json"},{"slug":"definitions/synonyms","title":"Synonyms","category":"Definitions","categorySlug":"definitions","summary":"A table synonym or Q-pointer is a special record in a master dictionary or table dictionary that points to another table, either in the same database or not.","url":"https://d3codex.com/definitions/synonyms/","api":"https://d3codex.com/api/topics/definitions/synonyms.json"},{"slug":"definitions/sysbase","title":"Sysbase","category":"Definitions","categorySlug":"definitions","summary":"Sysbase refers to the first frame where data is stored on the disk.","url":"https://d3codex.com/definitions/sysbase/","api":"https://d3codex.com/api/topics/definitions/sysbase.json"},{"slug":"definitions/system-delimiters","title":"System delimiters","category":"Definitions","categorySlug":"definitions","summary":"System delimiters refer to:","url":"https://d3codex.com/definitions/system-delimiters/","api":"https://d3codex.com/api/topics/definitions/system-delimiters.json"},{"slug":"definitions/system-privileges","title":"System privileges","category":"Definitions","categorySlug":"definitions","summary":"System privileges determine which processes the user has access to or can invoke.","url":"https://d3codex.com/definitions/system-privileges/","api":"https://d3codex.com/api/topics/definitions/system-privileges.json"},{"slug":"definitions/tape-handling-commands","title":"Tape handling commands","category":"Definitions","categorySlug":"definitions","summary":"All processes that handle magnetic media are classified as tape handling commands. All references to media and tape mean the same thing. Control is returned to the calling program when the user quits from a parity error.","url":"https://d3codex.com/definitions/tape-handling-commands/","api":"https://d3codex.com/api/topics/definitions/tape-handling-commands.json"},{"slug":"definitions/tape-socket","title":"Tape socket","category":"Definitions","categorySlug":"definitions","summary":"Tape socket defines a tape system across a network. This section is an introduction to the functionality of the tape over a network subsystem.","url":"https://d3codex.com/definitions/tape-socket/","api":"https://d3codex.com/api/topics/definitions/tape-socket.json"},{"slug":"definitions/transaction-logger","title":"Transaction logger","category":"Definitions","categorySlug":"definitions","summary":"The transaction logger is a subsystem designed to write file system updates to another device.","url":"https://d3codex.com/definitions/transaction-logger/","api":"https://d3codex.com/api/topics/definitions/transaction-logger.json"},{"slug":"definitions/unix-files-glossary","title":"UNIX files","category":"Definitions","categorySlug":"definitions","summary":"Through the OSFI, it is possible to access UNIX files as if they were D3 items, using AQL, BASIC, FlashBASIC, and so on. This section describes the format of the Q-pointer, the file structure and the access rules.","url":"https://d3codex.com/definitions/unix-files-glossary/","api":"https://d3codex.com/api/topics/definitions/unix-files-glossary.json"},{"slug":"definitions/user-exits","title":"User exits","category":"Definitions","categorySlug":"definitions","summary":"User exits allow direct references to assembler routines known as modes. These are generally not needed for new applications and are provided primarily for backwards compatibility and specialty utilities that must access internal structures.","url":"https://d3codex.com/definitions/user-exits/","api":"https://d3codex.com/api/topics/definitions/user-exits.json"},{"slug":"definitions/user-id","title":"User-ID","category":"Definitions","categorySlug":"definitions","summary":"A user-ID identifies a user. User-IDs are found in the dm,users, file.","url":"https://d3codex.com/definitions/user-id/","api":"https://d3codex.com/api/topics/definitions/user-id.json"},{"slug":"definitions/value","title":"Value","category":"Definitions","categorySlug":"definitions","summary":"A value is the field used to store data within an attribute of an item.","url":"https://d3codex.com/definitions/value/","api":"https://d3codex.com/api/topics/definitions/value.json"},{"slug":"definitions/value-mark","title":"Value mark","category":"Definitions","categorySlug":"definitions","summary":"A value mark is the specific metacharacter used within D3 items to indicate the end of a value, and the beginning of another.","url":"https://d3codex.com/definitions/value-mark/","api":"https://d3codex.com/api/topics/definitions/value-mark.json"},{"slug":"definitions/var","title":"var","category":"Definitions","categorySlug":"definitions","summary":"The var file is a pseudo file that maps to the user’s TCL shell variables.","url":"https://d3codex.com/definitions/var/","api":"https://d3codex.com/api/topics/definitions/var.json"},{"slug":"definitions/virtual-machine","title":"Virtual machine","category":"Definitions","categorySlug":"definitions","summary":"A virtual machine is a set of resources obtained from UNIX at initialization time that display the functions and characteristics of a D3 computer system, and are shared by several D3 processes.","url":"https://d3codex.com/definitions/virtual-machine/","api":"https://d3codex.com/api/topics/definitions/virtual-machine.json"},{"slug":"definitions/workgroup","title":"Workgroup","category":"Definitions","categorySlug":"definitions","summary":"Workgroup is a collection of systems on a network that work as peers.","url":"https://d3codex.com/definitions/workgroup/","api":"https://d3codex.com/api/topics/definitions/workgroup.json"},{"slug":"editor/a-command-editor-processor","title":"a command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The a command repeats the last l command issued in the line Editor.","url":"https://d3codex.com/editor/a-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/a-command-editor-processor.json"},{"slug":"editor/ap-command-editor-processor","title":"ap command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The ap command appends a string of characters to the end of one line, or to the ends of all consecutive lines within a range.","url":"https://d3codex.com/editor/ap-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/ap-command-editor-processor.json"},{"slug":"editor/as-command","title":"as command","category":"Editor","categorySlug":"editor","summary":"The as command toggles the assembly format on or off. It is used exclusively on D3 assembler source listings to format the instructions and operands into a more readable format.","url":"https://d3codex.com/editor/as-command/","api":"https://d3codex.com/api/topics/editor/as-command.json"},{"slug":"editor/b-command-editor-processor","title":"b command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The b command positions the line pointer to the end (bottom, or last line) of the current item.","url":"https://d3codex.com/editor/b-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/b-command-editor-processor.json"},{"slug":"editor/c-command-editor-processor","title":"c command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The c command displays a column position guide to indicate the actual positions of characters on the screen for use with the l and r commands.","url":"https://d3codex.com/editor/c-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/c-command-editor-processor.json"},{"slug":"editor/caret-command","title":"^ command","category":"Editor","categorySlug":"editor","summary":"The ^ command toggles the function of the wildcard search character used in the l and r commands. Initially, this function is on. When toggled off, the ^ is treated as any other character. This allows the r command to look for a literal ^, rather than treating ^ as a wildcard.","url":"https://d3codex.com/editor/caret-command/","api":"https://d3codex.com/api/topics/editor/caret-command.json"},{"slug":"editor/de-command-editor-processor","title":"de command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The de command deletes one or more lines from the current item, starting at the current line number position. If a string is specified, only the lines containing the string are deleted. Lines are not actually deleted until the item is filed with an f command. See x command to cancel the de.","url":"https://d3codex.com/editor/de-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/de-command-editor-processor.json"},{"slug":"editor/editor-commands","title":"Editor commands","category":"Editor","categorySlug":"editor","summary":"The following Editor commands are available.","url":"https://d3codex.com/editor/editor-commands/","api":"https://d3codex.com/api/topics/editor/editor-commands.json"},{"slug":"editor/editor-overview","title":"Editor overview","category":"Editor","categorySlug":"editor","summary":"The Editor is a tool used for adding, changing and deleting items in files. It is a line-oriented editor, and provides an assortment of commands that move the line pointer to specific attributes (lines) in the item being edited. The . (period) is the prompt when working in the Editor.","url":"https://d3codex.com/editor/editor-overview/","api":"https://d3codex.com/api/topics/editor/editor-overview.json"},{"slug":"editor/editor-processor","title":"Editor processor","category":"Editor","categorySlug":"editor","summary":"This section discusses the Editor processor.","url":"https://d3codex.com/editor/editor-processor/","api":"https://d3codex.com/api/topics/editor/editor-processor.json"},{"slug":"editor/error-messages","title":"Error messages","category":"Editor","categorySlug":"editor","summary":"Below is a brief discussion of the various error messages associated with the line Editor.","url":"https://d3codex.com/editor/error-messages/","api":"https://d3codex.com/api/topics/editor/error-messages.json"},{"slug":"editor/ex-command","title":"ex command","category":"Editor","categorySlug":"editor","summary":"The ex command exits the current item without saving changes. Control returns to TCL, or to the next item in the list if more than one item was requested.","url":"https://d3codex.com/editor/ex-command/","api":"https://d3codex.com/api/topics/editor/ex-command.json"},{"slug":"editor/exk-command","title":"exk command","category":"Editor","categorySlug":"editor","summary":"The exk command exits the current item without saving changes and returns control directly to TCL, abandoning any active list, if present.","url":"https://d3codex.com/editor/exk-command/","api":"https://d3codex.com/api/topics/editor/exk-command.json"},{"slug":"editor/f-command-editor-processor","title":"f command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The f command files the dual Editor buffers so that additional changes may be made to an item, or to review previous changes. After filing, the line pointer is positioned to the beginning (top) of the item. Changes to items must be made from the top down. This means that changes may not be made to any line above a line that a change has already been made without previously using the f command.","url":"https://d3codex.com/editor/f-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/f-command-editor-processor.json"},{"slug":"editor/fd-command","title":"fd command","category":"Editor","categorySlug":"editor","summary":"The fd command deletes the current item. Control returns to TCL, or to the next item in the list, if more than one item was requested. The default behavior of the fd command unconditionally prompts for confirmation of the deletion.","url":"https://d3codex.com/editor/fd-command/","api":"https://d3codex.com/api/topics/editor/fd-command.json"},{"slug":"editor/fdk-command","title":"fdk command","category":"Editor","categorySlug":"editor","summary":"The fdk command deletes the current item and abandons an active list, if present. Control returns directly to TCL.","url":"https://d3codex.com/editor/fdk-command/","api":"https://d3codex.com/api/topics/editor/fdk-command.json"},{"slug":"editor/fi-command","title":"fi command","category":"Editor","categorySlug":"editor","summary":"The fi command files the current item, saving all changes made. Control returns to TCL or to the next item in the active list.","url":"https://d3codex.com/editor/fi-command/","api":"https://d3codex.com/api/topics/editor/fi-command.json"},{"slug":"editor/fs-command","title":"fs command","category":"Editor","categorySlug":"editor","summary":"The fs command saves a copy of the current item and remains in the Editor within the current item. It is essentially the same as the fi command, but does not exit the item. When editing large items, periodically issue an fs command to ensure an update to the file. A different file reference and/or item-ID may be specified prior to saving the item.","url":"https://d3codex.com/editor/fs-command/","api":"https://d3codex.com/api/topics/editor/fs-command.json"},{"slug":"editor/fso-command","title":"fso command","category":"Editor","categorySlug":"editor","summary":"The fso command saves the current item and overwrites the item when a duplicate item-ID already exists on file. This form is used when specifying an item-ID other than the one originally requested.","url":"https://d3codex.com/editor/fso-command/","api":"https://d3codex.com/api/topics/editor/fso-command.json"},{"slug":"editor/g-command-editor-processor","title":"g command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The g command positions the line pointer to a specific line. The attribute number (line number) may be entered without the g command.","url":"https://d3codex.com/editor/g-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/g-command-editor-processor.json"},{"slug":"editor/h-command-editor-processor","title":"h command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The h command toggles the display between ASCII and hexadecimal-encoded ASCII.","url":"https://d3codex.com/editor/h-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/h-command-editor-processor.json"},{"slug":"editor/i-command","title":"i command","category":"Editor","categorySlug":"editor","summary":"The i command places the Editor into insert mode to enter one or more lines. Pressing Enter at the first position of a line while in insert mode returns control to command mode.","url":"https://d3codex.com/editor/i-command/","api":"https://d3codex.com/api/topics/editor/i-command.json"},{"slug":"editor/l-command-editor-processor","title":"l command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The l command lists a specified number of lines that contain a search string and increments the line pointer to the last line listed. The l command locates one or more occurrences of a text string within a specified range of line (attribute) numbers.","url":"https://d3codex.com/editor/l-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/l-command-editor-processor.json"},{"slug":"editor/m-command","title":"m command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The m command is used exclusively on D3 assembler source listings to expand included macros into a more readable format.","url":"https://d3codex.com/editor/m-command/","api":"https://d3codex.com/api/topics/editor/m-command.json"},{"slug":"editor/me-command","title":"me command","category":"Editor","categorySlug":"editor","summary":"The me command merges one or more lines from the current item, another item in the current file, or another item in a different file.","url":"https://d3codex.com/editor/me-command/","api":"https://d3codex.com/api/topics/editor/me-command.json"},{"slug":"editor/n-command-editor-processor","title":"n command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The n command positions the line pointer down a specified number of lines from the current position. Followed by pressing ENTER, the n command redisplays the current line.","url":"https://d3codex.com/editor/n-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/n-command-editor-processor.json"},{"slug":"editor/o-command-editor-processor","title":"o command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The o command sets object assembly mode in the Editor.","url":"https://d3codex.com/editor/o-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/o-command-editor-processor.json"},{"slug":"editor/p-command-editor-processor","title":"p command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The p command either defines or executes a pre-stored command; p by itself assumes p0 (zero).","url":"https://d3codex.com/editor/p-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/p-command-editor-processor.json"},{"slug":"editor/pd-command","title":"pd command","category":"Editor","categorySlug":"editor","summary":"The pd command displays any prestored command.","url":"https://d3codex.com/editor/pd-command/","api":"https://d3codex.com/api/topics/editor/pd-command.json"},{"slug":"editor/question-command-editor","title":"? command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The ? (question mark) command displays the current file name and item-ID of the item currently being edited and the line number where the line pointer is positioned.","url":"https://d3codex.com/editor/question-command-editor/","api":"https://d3codex.com/api/topics/editor/question-command-editor.json"},{"slug":"editor/r-command-editor-processor","title":"r command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The r command replaces the current line, replaces a string of characters within the current line, or replaces a string of characters within a specific range of lines.","url":"https://d3codex.com/editor/r-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/r-command-editor-processor.json"},{"slug":"editor/s-command-editor-processor","title":"s command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The s command toggles the display of Editor line numbers in normal Editor mode, and suppresses the display of object code when the assembly formatter is on.","url":"https://d3codex.com/editor/s-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/s-command-editor-processor.json"},{"slug":"editor/s-question-mark-command","title":"s? command","category":"Editor","categorySlug":"editor","summary":"The s? command displays the size of the current item in bytes.","url":"https://d3codex.com/editor/s-question-mark-command/","api":"https://d3codex.com/api/topics/editor/s-question-mark-command.json"},{"slug":"editor/sl-command","title":"sl command","category":"Editor","categorySlug":"editor","summary":"The sl command sets the number of lines, rather than attributes, to display by the default p (prestored) command, p0 (zero).","url":"https://d3codex.com/editor/sl-command/","api":"https://d3codex.com/api/topics/editor/sl-command.json"},{"slug":"editor/t-command-editor-processor","title":"t command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The t command positions the line pointer to the beginning (top) of the item, without filing the data. The f command also positions to the top of the item. Any lines inserted at the top of the program are placed before line 1 of the item.","url":"https://d3codex.com/editor/t-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/t-command-editor-processor.json"},{"slug":"editor/tb-command","title":"tb command","category":"Editor","categorySlug":"editor","summary":"The tb command defines tab stops for use by subsequent uses of the TAB key.","url":"https://d3codex.com/editor/tb-command/","api":"https://d3codex.com/api/topics/editor/tb-command.json"},{"slug":"editor/u-command-editor-processor","title":"u command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The u command moves the line pointer up a specific number of lines from the current position.","url":"https://d3codex.com/editor/u-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/u-command-editor-processor.json"},{"slug":"editor/using-the-enter-key","title":"Using the Enter key","category":"Editor","categorySlug":"editor","summary":"Pressing ENTER advances the line pointer to the next line and displays the line if in command mode. If in insert mode and at a blank line, it returns to command mode. Pressing CTRL+M is the same as pressing ENTER.","url":"https://d3codex.com/editor/using-the-enter-key/","api":"https://d3codex.com/api/topics/editor/using-the-enter-key.json"},{"slug":"editor/wildcards","title":"Wildcards","category":"Editor","categorySlug":"editor","summary":"The ^ is used as a wildcard search character within the string parameter for replacing known and sometimes unknown strings within strings. It matches any character. Note that ^ is a normal character, not a control character. See the r/^^^// example below.","url":"https://d3codex.com/editor/wildcards/","api":"https://d3codex.com/api/topics/editor/wildcards.json"},{"slug":"editor/x-command-editor-processor","title":"x command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The x command cancels the effect of the last i (insert), ap (append), de (delete), me (merge), or r (replace) command.","url":"https://d3codex.com/editor/x-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/x-command-editor-processor.json"},{"slug":"editor/xf-command","title":"xf command","category":"Editor","categorySlug":"editor","summary":"The xf command cancels the effect of all commands executed since the last f command was issued.","url":"https://d3codex.com/editor/xf-command/","api":"https://d3codex.com/api/topics/editor/xf-command.json"},{"slug":"editor/z-command-editor-processor","title":"z command (Editor processor)","category":"Editor","categorySlug":"editor","summary":"The z command defines zone display limits.","url":"https://d3codex.com/editor/z-command-editor-processor/","api":"https://d3codex.com/api/topics/editor/z-command-editor-processor.json"},{"slug":"flashbasicdebugger/b-command-flashbasic-debugger","title":"b command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The b command establishes a breakpoint condition in the breakpoint table that causes the program to enter the BASIC/FlashBASIC debugger when the condition defined in the breakpoint expression is met.","url":"https://d3codex.com/flashbasicdebugger/b-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/b-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/backslash-command","title":"\\ command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The \\ command is used by the BASIC/FlashBASIC debugger to display the current value of a variable or integer expression.","url":"https://d3codex.com/flashbasicdebugger/backslash-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/backslash-command.json"},{"slug":"flashbasicdebugger/basic-flashbasic-debugger","title":"BASIC/FlashBASIC Debugger","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The BASIC/FlashBASIC debugger facilitates the debugging of new BASIC or FlashBASIC programs and the maintenance of existing BASIC or FlashBASIC programs.","url":"https://d3codex.com/flashbasicdebugger/basic-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/basic-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/c-command-flashbasic-debugger","title":"c command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The c command toggles on or off the display of the current source line when stepping through the program with CTRL+J. When this function is on, the line displays after it has been executed.","url":"https://d3codex.com/flashbasicdebugger/c-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/c-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/ctrl-j-command","title":"CTRL+J command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The CTRL+J command has the same effect as the BASIC/FlashBASIC debugger g command, except that CTRL+J only requires one character. If the BASIC/FlashBASIC debugger c option is enabled, CTRL+J also displays the BASIC instruction after it is executed.","url":"https://d3codex.com/flashbasicdebugger/ctrl-j-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/ctrl-j-command.json"},{"slug":"flashbasicdebugger/ctrl-n-command","title":"CTRL+N command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The CTRL+N command is similar to the BASIC/FlashBASIC debugger g command except that if single-stepping is active, the CTRL+N command will step over any subroutine calls.","url":"https://d3codex.com/flashbasicdebugger/ctrl-n-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/ctrl-n-command.json"},{"slug":"flashbasicdebugger/d-command-flashbasic-debugger","title":"d command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The d command displays the contents of the breakpoint and trace table.","url":"https://d3codex.com/flashbasicdebugger/d-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/d-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/de-command-flashbasic-debugger","title":"de command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The de command invokes the system debugger from the BASIC/FlashBASIC debugger. Issuing a g command from the system debugger returns control to the BASIC/FlashBASIC debugger. The de command is identical to the debug command at TCL.","url":"https://d3codex.com/flashbasicdebugger/de-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/de-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/debug-command-flashbasic-debugger","title":"debug command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The debug command temporarily exits the BASIC/FlashBASIC debugger and invokes the system debugger. Issuing a g command from the system debugger returns control to the BASIC/FlashBASIC debugger.","url":"https://d3codex.com/flashbasicdebugger/debug-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/debug-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/dollar-command","title":"Dollar command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The $ command displays the current program name and current line number, and verifies the object code. The object code is verified by performing a checksum verification. This is used to determine if the object code has been corrupted since the last time it was compiled. The $ and ? commands are identical.","url":"https://d3codex.com/flashbasicdebugger/dollar-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/dollar-command.json"},{"slug":"flashbasicdebugger/dollar-exclamation-command","title":"$! command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The $! command displays the current call stack with parameter names and values being shown. If the symbol table is not present, the internal names are shown.","url":"https://d3codex.com/flashbasicdebugger/dollar-exclamation-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/dollar-exclamation-command.json"},{"slug":"flashbasicdebugger/down-command","title":"down command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The down command is used in the BASIC/FlashBASIC debugger to move down the call stack.","url":"https://d3codex.com/flashbasicdebugger/down-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/down-command.json"},{"slug":"flashbasicdebugger/e-command","title":"e command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The e command indicates the number of instructions to execute prior to returning to the BASIC/FlashBASIC debugger.","url":"https://d3codex.com/flashbasicdebugger/e-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/e-command.json"},{"slug":"flashbasicdebugger/edit-command-basic-flashbasic-debugger","title":"edit command (BASIC/FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The edit command invokes the Update processor for editing the current program from within the BASIC/FlashBASIC debugger. It automatically positions the cursor at the current execution line number.","url":"https://d3codex.com/flashbasicdebugger/edit-command-basic-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/edit-command-basic-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/end-command-flashbasic-debugger","title":"end command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The end command terminates the run-time portion of a BASIC or FlashBASIC program, exits the debugger, and returns control to TCL.","url":"https://d3codex.com/flashbasicdebugger/end-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/end-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/entering-the-debugger-basic-flashbasic-debugger","title":"Entering the Debugger (BASIC/FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"When the BASIC/FlashBASIC debugger is entered, it indicates the source code line number is to be executed next and prompts for commands with an asterisk.","url":"https://d3codex.com/flashbasicdebugger/entering-the-debugger-basic-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/entering-the-debugger-basic-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/flashbasic-debugger-commands","title":"FlashBASIC Debugger commands","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"When the BASIC/FlashBASIC debugger is entered, it indicates the source code line number to be executed next and prompts for commands with an asterisk.","url":"https://d3codex.com/flashbasicdebugger/flashbasic-debugger-commands/","api":"https://d3codex.com/api/topics/flashbasicdebugger/flashbasic-debugger-commands.json"},{"slug":"flashbasicdebugger/g-command-flashbasic-debugger","title":"g command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The g command resumes execution of a program after it has been interrupted by the execution of a BASIC/FlashBASIC debug statement or by pressing ESC or BREAK.","url":"https://d3codex.com/flashbasicdebugger/g-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/g-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/h-command-flashbasic-debugger","title":"h command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The h command displays the help information, and shows all the available BASIC and FlashBASIC debugger commands.","url":"https://d3codex.com/flashbasicdebugger/h-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/h-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/k-command","title":"k command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The k (kill) command kills a breakpoint previously set with the b command, and removes the entry from the breakpoint table. The k command, followed by pressing ENTER, removes all breakpoint entries from the table.","url":"https://d3codex.com/flashbasicdebugger/k-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/k-command.json"},{"slug":"flashbasicdebugger/l-command-flashbasic-debugger","title":"l command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The l command lists the current source line, or a specified range of lines, from the corresponding source program being executed. The l* form displays the entire program. The l command, followed by pressing ENTER, displays the current program source line.","url":"https://d3codex.com/flashbasicdebugger/l-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/l-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/left-bracket-command","title":"[ command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The [ command sets the left output zone limits of debugger display.","url":"https://d3codex.com/flashbasicdebugger/left-bracket-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/left-bracket-command.json"},{"slug":"flashbasicdebugger/lp-command","title":"lp command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The lp command toggles the line printer bit status, either directing debugger output to the terminal screen or to the Spooler. This is the equivalent to issuing a printer on statement within the program.","url":"https://d3codex.com/flashbasicdebugger/lp-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/lp-command.json"},{"slug":"flashbasicdebugger/m-command","title":"m command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The m command toggles modal trapping on and off.","url":"https://d3codex.com/flashbasicdebugger/m-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/m-command.json"},{"slug":"flashbasicdebugger/n-command-flashbasic-debugger","title":"n command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The n command ignores any debugger breakpoint conditions for a specific number of occurrences.","url":"https://d3codex.com/flashbasicdebugger/n-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/n-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/off-command-flashbasic-debugger","title":"off command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The off command stops processing at all levels on the current port and returns control to the initial logon prompt.","url":"https://d3codex.com/flashbasicdebugger/off-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/off-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/p-command-flashbasic-debugger","title":"p command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The p command toggles disabling output display; debugger output is still displayed.","url":"https://d3codex.com/flashbasicdebugger/p-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/p-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/pc-command","title":"pc command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The pc command closes the current spooler entry and releases the print job to the Spooler.","url":"https://d3codex.com/flashbasicdebugger/pc-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/pc-command.json"},{"slug":"flashbasicdebugger/pound-command","title":"# command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The # command displays the item-ID of the error message that caused the most recent abort into the BASIC/FlashBASIC debugger.","url":"https://d3codex.com/flashbasicdebugger/pound-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/pound-command.json"},{"slug":"flashbasicdebugger/question-command-flashbasic-debugger","title":"? command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The ? command displays the current program name and line number.","url":"https://d3codex.com/flashbasicdebugger/question-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/question-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/question-exclamation-command","title":"?! command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The ?! command is used in the BASIC/FlashBASIC debugger to display the current call stack with current parameter values being shown.","url":"https://d3codex.com/flashbasicdebugger/question-exclamation-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/question-exclamation-command.json"},{"slug":"flashbasicdebugger/r-command-flashbasic-debugger","title":"r command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The r command pops the top return stack address of the local subroutine from the stack, causing the next return command to return to the address revealed by the pop.","url":"https://d3codex.com/flashbasicdebugger/r-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/r-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/referencing-variables","title":"Referencing variables","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"When in the debugger, the current value of any variable may be examined (and optionally changed) using the forms listed.","url":"https://d3codex.com/flashbasicdebugger/referencing-variables/","api":"https://d3codex.com/api/topics/flashbasicdebugger/referencing-variables.json"},{"slug":"flashbasicdebugger/return-command","title":"return command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The return command returns from the current subroutine in the BASIC/FlashBASIC debugger. All code from the current debug point to the end of the routine is executed normally.","url":"https://d3codex.com/flashbasicdebugger/return-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/return-command.json"},{"slug":"flashbasicdebugger/right-bracket-command","title":"] command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The ] command sets the right output zone limits of debugger display.","url":"https://d3codex.com/flashbasicdebugger/right-bracket-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/right-bracket-command.json"},{"slug":"flashbasicdebugger/right-carat-command","title":"> command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The > command executes any TCL command typed concatenated after the > and returns to the BASIC debugger.","url":"https://d3codex.com/flashbasicdebugger/right-carat-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/right-carat-command.json"},{"slug":"flashbasicdebugger/s-command-flashbasic-debugger","title":"s command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The s command displays the contents of the subroutine stack.","url":"https://d3codex.com/flashbasicdebugger/s-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/s-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/slash-command","title":"/ command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The / command references and optionally alters the contents of variables within the run-time code being executed.","url":"https://d3codex.com/flashbasicdebugger/slash-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/slash-command.json"},{"slug":"flashbasicdebugger/symbol-table-flashbasic-debugger","title":"Symbol table (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"When a BASIC or FlashBASIC program is compiled, a symbol table is generated, unless the s (suppress table) option has been used with the compile or basic TCL command. The symbol table is stored as part of the object code and is used by the BASIC/FlashBASIC debugger to reference symbolic variables.","url":"https://d3codex.com/flashbasicdebugger/symbol-table-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/symbol-table-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/t-command-flashbasic-debugger","title":"t command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The t command places a given variable into the trace table, causing the debugger to display the specified data element along with the contents of the break and trace tables on each break.","url":"https://d3codex.com/flashbasicdebugger/t-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/t-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/u-command-flashbasic-debugger","title":"u command (FlashBASIC Debugger)","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The u command removes from the trace table a given variable, or all variables, previously specified with the t command.","url":"https://d3codex.com/flashbasicdebugger/u-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/u-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/up-command","title":"up command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The up command is used in the BASIC/FlashBASIC debugger to move up the call stack.","url":"https://d3codex.com/flashbasicdebugger/up-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/up-command.json"},{"slug":"flashbasicdebugger/v-command","title":"v command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The v command verifies the current BASIC object code by performing a checksum verification. This determines if the object code has been corrupted since the last time it was compiled.","url":"https://d3codex.com/flashbasicdebugger/v-command/","api":"https://d3codex.com/api/topics/flashbasicdebugger/v-command.json"},{"slug":"flashbasicdebugger/z-command-flashbasic-debugger","title":"z command","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The z command loads the program source if available.","url":"https://d3codex.com/flashbasicdebugger/z-command-flashbasic-debugger/","api":"https://d3codex.com/api/topics/flashbasicdebugger/z-command-flashbasic-debugger.json"},{"slug":"flashbasicdebugger/zone-output-specification","title":"Zone output specification","category":"FlashBASIC Debugger","categorySlug":"flashbasicdebugger","summary":"The zone command sets left and right output zone limits of debugger display.","url":"https://d3codex.com/flashbasicdebugger/zone-output-specification/","api":"https://d3codex.com/api/topics/flashbasicdebugger/zone-output-specification.json"},{"slug":"introduction/commands-that-function-differently-in-d3-windows-vs-unix","title":"Commands that function differently in D3 Windows versus UNIX","category":"Introduction","categorySlug":"introduction","summary":"The following commands are supported for both D3 Windows and D3 UNIX implementations. However, the command functionality differs depending on the platform.","url":"https://d3codex.com/introduction/commands-that-function-differently-in-d3-windows-vs-unix/","api":"https://d3codex.com/api/topics/introduction/commands-that-function-differently-in-d3-windows-vs-unix.json"},{"slug":"introduction/d3-overview","title":"D3 overview","category":"Introduction","categorySlug":"introduction","summary":"D3 is a generalized database management language and system that provides tools to manage information in a flexible, efficient, and timely manner. The essence of developing an application with D3 is to define the problem in terms of information and relationships between information.","url":"https://d3codex.com/introduction/d3-overview/","api":"https://d3codex.com/api/topics/introduction/d3-overview.json"},{"slug":"introduction/d3-reference-manual-overview","title":"D3 Reference Manual overview","category":"Introduction","categorySlug":"introduction","summary":"This introduction provides a brief overview of D3, discusses D3 Windows and D3 UNIX differences, and defines the D3 VME and FSI features.","url":"https://d3codex.com/introduction/d3-reference-manual-overview/","api":"https://d3codex.com/api/topics/introduction/d3-reference-manual-overview.json"},{"slug":"introduction/d3-unix-unsupported-commands","title":"D3 UNIX unsupported commands","category":"Introduction","categorySlug":"introduction","summary":"The commands below are not supported for D3 UNIX implementations.","url":"https://d3codex.com/introduction/d3-unix-unsupported-commands/","api":"https://d3codex.com/api/topics/introduction/d3-unix-unsupported-commands.json"},{"slug":"introduction/d3-windows-and-unix-differences","title":"D3 Windows and UNIX differences","category":"Introduction","categorySlug":"introduction","summary":"This section lists and describes any differences that exist between D3 Windows and D3 UNIX implementations.","url":"https://d3codex.com/introduction/d3-windows-and-unix-differences/","api":"https://d3codex.com/api/topics/introduction/d3-windows-and-unix-differences.json"},{"slug":"introduction/d3-windows-specific-behavior","title":"D3 Windows specific behavior","category":"Introduction","categorySlug":"introduction","summary":"The following behaviors are unique to D3 Windows:","url":"https://d3codex.com/introduction/d3-windows-specific-behavior/","api":"https://d3codex.com/api/topics/introduction/d3-windows-specific-behavior.json"},{"slug":"introduction/d3-windows-unsupported-commands","title":"D3 Windows unsupported commands","category":"Introduction","categorySlug":"introduction","summary":"The commands below are not supported for D3 Windows implementations.","url":"https://d3codex.com/introduction/d3-windows-unsupported-commands/","api":"https://d3codex.com/api/topics/introduction/d3-windows-unsupported-commands.json"},{"slug":"introduction/features-not-supported-for-d3-windows","title":"Features not supported for D3 Windows","category":"Introduction","categorySlug":"introduction","summary":"The following features have not been implemented on D3 Windows:","url":"https://d3codex.com/introduction/features-not-supported-for-d3-windows/","api":"https://d3codex.com/api/topics/introduction/features-not-supported-for-d3-windows.json"},{"slug":"introduction/flashbasic-features-that-function-differently-in-d3-windows-vs-unix","title":"FlashBASIC features that function differently in D3 Windows vs. UNIX","category":"Introduction","categorySlug":"introduction","summary":"The FlashBASIC features listed below either differ in functionality for each platform or are not supported for one of the platforms.","url":"https://d3codex.com/introduction/flashbasic-features-that-function-differently-in-d3-windows-vs-unix/","api":"https://d3codex.com/api/topics/introduction/flashbasic-features-that-function-differently-in-d3-windows-vs-unix.json"},{"slug":"introduction/vme-and-fsi-differences","title":"VME and FSI differences","category":"Introduction","categorySlug":"introduction","summary":"Virtual Machine Environment (VME) is a set of resources obtained from the host operating system at utilization time and is the compatibility layer for applications.","url":"https://d3codex.com/introduction/vme-and-fsi-differences/","api":"https://d3codex.com/api/topics/introduction/vme-and-fsi-differences.json"},{"slug":"output-processor/asterisk-comment-command","title":"* comment command","category":"Output Processor","categorySlug":"output-processor","summary":"The * command treats the entire line following the asterisk as a remark. Any text following the command is ignored by the Output processor.","url":"https://d3codex.com/output-processor/asterisk-comment-command/","api":"https://d3codex.com/api/topics/output-processor/asterisk-comment-command.json"},{"slug":"output-processor/dot-appendix-command","title":".appendix command","category":"Output Processor","categorySlug":"output-processor","summary":"The .appendix command alphabetically assigns letters to appendix titles and creates entries in the table of contents.","url":"https://d3codex.com/output-processor/dot-appendix-command/","api":"https://d3codex.com/api/topics/output-processor/dot-appendix-command.json"},{"slug":"output-processor/dot-begin-page-command-output-processor","title":".begin page command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .begin page command forces a page break. A page break terminates the current page, prints the optional footing, ejects a page, increments the page counter, and prints the optional heading. The text immediately following the .begin page command is printed on the next page.","url":"https://d3codex.com/output-processor/dot-begin-page-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-begin-page-command-output-processor.json"},{"slug":"output-processor/dot-block-center-command","title":".block center command","category":"Output Processor","categorySlug":"output-processor","summary":"The .block center command centers all of the attributes following the command until an .xblock center command is issued.","url":"https://d3codex.com/output-processor/dot-block-center-command/","api":"https://d3codex.com/api/topics/output-processor/dot-block-center-command.json"},{"slug":"output-processor/dot-boldface-command","title":".boldface command","category":"Output Processor","categorySlug":"output-processor","summary":"The .boldface command prints text in boldface until an .xboldface command is encountered. If the printer does not have a boldface font, the text is double struck. On terminals boldfaced text is often displayed as reverse-video.","url":"https://d3codex.com/output-processor/dot-boldface-command/","api":"https://d3codex.com/api/topics/output-processor/dot-boldface-command.json"},{"slug":"output-processor/dot-box-command-output-processor","title":".box command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .box command draws a box at the column positions specified in the command and overwrites anything that occupies those positions.","url":"https://d3codex.com/output-processor/dot-box-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-box-command-output-processor.json"},{"slug":"output-processor/dot-break-command-output-processor","title":".break command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .break command creates a new paragraph, is surrounded by at least one space, and can be placed anywhere in the text.","url":"https://d3codex.com/output-processor/dot-break-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-break-command-output-processor.json"},{"slug":"output-processor/dot-cap-sentences-command","title":".cap sentences command","category":"Output Processor","categorySlug":"output-processor","summary":"The .cap sentences command capitalizes the first letter of each sentence or attribute.","url":"https://d3codex.com/output-processor/dot-cap-sentences-command/","api":"https://d3codex.com/api/topics/output-processor/dot-cap-sentences-command.json"},{"slug":"output-processor/dot-center-command-output-processor","title":".center command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .center command centers the single line of text that follows the command, can be anywhere in the text, and does not need to be turned off. This command also causes a break (new paragraph) to occur.","url":"https://d3codex.com/output-processor/dot-center-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-center-command-output-processor.json"},{"slug":"output-processor/dot-chain-command-output-processor","title":".chain command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .chain command passes control to a specified item-ID in the same (current) file or in a different (file reference) file.","url":"https://d3codex.com/output-processor/dot-chain-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-chain-command-output-processor.json"},{"slug":"output-processor/dot-chapter-command-output-processor","title":".chapter command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .chapter command starts a new chapter.","url":"https://d3codex.com/output-processor/dot-chapter-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-chapter-command-output-processor.json"},{"slug":"output-processor/dot-char-command","title":".char command","category":"Output Processor","categorySlug":"output-processor","summary":"The .char command sends a raw string of characters to the printer or terminal without translation.","url":"https://d3codex.com/output-processor/dot-char-command/","api":"https://d3codex.com/api/topics/output-processor/dot-char-command.json"},{"slug":"output-processor/dot-col-command","title":".col command","category":"Output Processor","categorySlug":"output-processor","summary":"The .col command uses the column headings and spacing specified with the last .columns set or .variable columns command to determine the position of the specified column number. If the column number is less than the previous column number, the columns are printed and a new paragraph begins. A maximum of seven columns are available.","url":"https://d3codex.com/output-processor/dot-col-command/","api":"https://d3codex.com/api/topics/output-processor/dot-col-command.json"},{"slug":"output-processor/dot-columns-set-command","title":".columns set command","category":"Output Processor","categorySlug":"output-processor","summary":"The .columns set command specifies the column heading, column width, and column spacing.","url":"https://d3codex.com/output-processor/dot-columns-set-command/","api":"https://d3codex.com/api/topics/output-processor/dot-columns-set-command.json"},{"slug":"output-processor/dot-crt-command-output-processor","title":".crt command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .crt command directs the output from the Output processor to the terminal, overriding the p option specified at TCL.","url":"https://d3codex.com/output-processor/dot-crt-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-crt-command-output-processor.json"},{"slug":"output-processor/dot-cursor-command","title":".cursor command","category":"Output Processor","categorySlug":"output-processor","summary":"The .cursor command outputs the text on the column and row specified.","url":"https://d3codex.com/output-processor/dot-cursor-command/","api":"https://d3codex.com/api/topics/output-processor/dot-cursor-command.json"},{"slug":"output-processor/dot-date-command","title":".date command","category":"Output Processor","categorySlug":"output-processor","summary":"The .date command outputs the current system date in the form month day, year.","url":"https://d3codex.com/output-processor/dot-date-command/","api":"https://d3codex.com/api/topics/output-processor/dot-date-command.json"},{"slug":"output-processor/dot-default-command","title":".default command","category":"Output Processor","categorySlug":"output-processor","summary":"The .default command sends the device a control code to select the default font.","url":"https://d3codex.com/output-processor/dot-default-command/","api":"https://d3codex.com/api/topics/output-processor/dot-default-command.json"},{"slug":"output-processor/dot-em-command","title":".em command","category":"Output Processor","categorySlug":"output-processor","summary":"The .em command inserts spaces in output text and is dependent on the printer type.","url":"https://d3codex.com/output-processor/dot-em-command/","api":"https://d3codex.com/api/topics/output-processor/dot-em-command.json"},{"slug":"output-processor/dot-end-case-command-output-processor","title":".end case command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .end case command disables any previous .upper case or .lower case commands.","url":"https://d3codex.com/output-processor/dot-end-case-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-end-case-command-output-processor.json"},{"slug":"output-processor/dot-figure-command","title":".figure command","category":"Output Processor","categorySlug":"output-processor","summary":"The .figure command numbers the figures sequentially using the current chapter number followed by a dash and the sequence number within the chapter.","url":"https://d3codex.com/output-processor/dot-figure-command/","api":"https://d3codex.com/api/topics/output-processor/dot-figure-command.json"},{"slug":"output-processor/dot-font-command","title":".font command","category":"Output Processor","categorySlug":"output-processor","summary":"The .font command selects the font defined in the device item or specifies fonts that are not predefined in the printer item. If the device does not support the fonts or the device item has not been configured, this command has no affect.","url":"https://d3codex.com/output-processor/dot-font-command/","api":"https://d3codex.com/api/topics/output-processor/dot-font-command.json"},{"slug":"output-processor/dot-footing-command-output-processor","title":".footing command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .footing command designates a text string composed of literals and special options to output at the bottom of each page. If the line following the .footing command is null, the footing is suppressed.","url":"https://d3codex.com/output-processor/dot-footing-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-footing-command-output-processor.json"},{"slug":"output-processor/dot-gohanging-tab-command","title":".gohanging tab command","category":"Output Processor","categorySlug":"output-processor","summary":"The .gohanging tab command indents the text to the column set by the previous .ht command.","url":"https://d3codex.com/output-processor/dot-gohanging-tab-command/","api":"https://d3codex.com/api/topics/output-processor/dot-gohanging-tab-command.json"},{"slug":"output-processor/dot-hanging-tab-command","title":".hanging tab command","category":"Output Processor","categorySlug":"output-processor","summary":"The .hanging tab command sets a tab stop at the column in the text where it is entered.","url":"https://d3codex.com/output-processor/dot-hanging-tab-command/","api":"https://d3codex.com/api/topics/output-processor/dot-hanging-tab-command.json"},{"slug":"output-processor/dot-heading-command-output-processor","title":".heading command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .heading command designates a text string composed of literals and special options to output at the top of each page. If the line following the .heading command is null, the heading is suppressed.","url":"https://d3codex.com/output-processor/dot-heading-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-heading-command-output-processor.json"},{"slug":"output-processor/dot-hilite-command-output-processor","title":".hilite command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .hilite command prints a single character on the right margin and is in effect until an .xhilite command is issued.","url":"https://d3codex.com/output-processor/dot-hilite-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-hilite-command-output-processor.json"},{"slug":"output-processor/dot-indent-command-output-processor","title":".indent command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .indent command indents the text following the command a specified number spaces from the left margin.","url":"https://d3codex.com/output-processor/dot-indent-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-indent-command-output-processor.json"},{"slug":"output-processor/dot-indent-margin-command-output-processor","title":".indent margin command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .indent margin command adjusts the left margin a specified number of spaces. If the command is in the middle of an attribute, the preceding text is output and the next word begins a new paragraph that is indented number of spaces.","url":"https://d3codex.com/output-processor/dot-indent-margin-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-indent-margin-command-output-processor.json"},{"slug":"output-processor/dot-indent-rmargin-command","title":".indent rmargin command","category":"Output Processor","categorySlug":"output-processor","summary":"The .indent rmargin command adjusts the right margin a specified number of spaces. If the command is in the middle of an attribute, the preceding text is output and the next word begins a new paragraph with a right margin of the specified number of spaces.","url":"https://d3codex.com/output-processor/dot-indent-rmargin-command/","api":"https://d3codex.com/api/topics/output-processor/dot-indent-rmargin-command.json"},{"slug":"output-processor/dot-index-command-output-processor","title":".index command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .index command inserts a phrase and the current page number into the index. The .index command may be embedded in text, in which case the end of the index text must be indicated by the .xindex command.","url":"https://d3codex.com/output-processor/dot-index-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-index-command-output-processor.json"},{"slug":"output-processor/dot-index-heading-command","title":".index heading command","category":"Output Processor","categorySlug":"output-processor","summary":"The .index heading command substitutes the heading text as the header for index pages. The heading text is output on the top of each index page.","url":"https://d3codex.com/output-processor/dot-index-heading-command/","api":"https://d3codex.com/api/topics/output-processor/dot-index-heading-command.json"},{"slug":"output-processor/dot-input-command-output-processor","title":".input command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .input command accepts and processes text input from the terminal.","url":"https://d3codex.com/output-processor/dot-input-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-input-command-output-processor.json"},{"slug":"output-processor/dot-italics-command","title":".italics command","category":"Output Processor","categorySlug":"output-processor","summary":"The .italics command causes the text following the command to be output in italics. If the printer does not support italics, this command has no affect.","url":"https://d3codex.com/output-processor/dot-italics-command/","api":"https://d3codex.com/api/topics/output-processor/dot-italics-command.json"},{"slug":"output-processor/dot-justify-command-output-processor","title":".justify command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .justify command right-aligns each line of text with the right margin by adding spaces in each line to pad to the end of the line. This command stays in affect until an .xjustify command is executed.","url":"https://d3codex.com/output-processor/dot-justify-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-justify-command-output-processor.json"},{"slug":"output-processor/dot-left-margin-command-output-processor","title":".left margin command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .left margin command sets the left margin at a specific number of spaces from the left edge of the paper and remains in affect until an .im, .left margin, or .standard command is issued.","url":"https://d3codex.com/output-processor/dot-left-margin-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-left-margin-command-output-processor.json"},{"slug":"output-processor/dot-line-length-command-output-processor","title":".line length command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .line length command sets the line length a specified number of characters from the left margin and remains in affect until changed by another .line length command.","url":"https://d3codex.com/output-processor/dot-line-length-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-line-length-command-output-processor.json"},{"slug":"output-processor/dot-line-printer-command","title":".line printer command","category":"Output Processor","categorySlug":"output-processor","summary":"The .line printer command sends all subsequent output to the currently assigned printer.","url":"https://d3codex.com/output-processor/dot-line-printer-command/","api":"https://d3codex.com/api/topics/output-processor/dot-line-printer-command.json"},{"slug":"output-processor/dot-lower-case-command-output-processor","title":".lower case command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .lower case command outputs text in lowercase characters. The .end case command terminates this command.","url":"https://d3codex.com/output-processor/dot-lower-case-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-lower-case-command-output-processor.json"},{"slug":"output-processor/dot-lpi-command","title":".lpi command","category":"Output Processor","categorySlug":"output-processor","summary":"The .lpi command sets the number of lines per inch for output. If the printer does not support the specified number of lines per inch, this command has no affect.","url":"https://d3codex.com/output-processor/dot-lpi-command/","api":"https://d3codex.com/api/topics/output-processor/dot-lpi-command.json"},{"slug":"output-processor/dot-macro-file-command","title":".macro file command","category":"Output Processor","categorySlug":"output-processor","summary":"The .macro file command defines the file name that contains the Output processor macro items. Macros may contain multiple Output processor commands and text.","url":"https://d3codex.com/output-processor/dot-macro-file-command/","api":"https://d3codex.com/api/topics/output-processor/dot-macro-file-command.json"},{"slug":"output-processor/dot-nofill-command-output-processor","title":".nofill command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .nofill command resets both the justify and fill modes. When using this command, there is no removal of extra spaces, end-of-line marks are not stripped from input, output lines are not filled, and the right margins are not justified. This command creates a break (new paragraph).","url":"https://d3codex.com/output-processor/dot-nofill-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-nofill-command-output-processor.json"},{"slug":"output-processor/dot-over-char-command","title":".over char command","category":"Output Processor","categorySlug":"output-processor","summary":"The .over char command treats all characters that follow it as text.","url":"https://d3codex.com/output-processor/dot-over-char-command/","api":"https://d3codex.com/api/topics/output-processor/dot-over-char-command.json"},{"slug":"output-processor/dot-page-length-command","title":".page length command","category":"Output Processor","categorySlug":"output-processor","summary":"The .page length command sets the page length to the number of lines specified. The physical page length, in terms of inches, can be calculated by the .vmi height of each of the printed lines multiplied by 1/48 of an inch. The length (in inches) of each page can vary as the vertical motion index is changed.","url":"https://d3codex.com/output-processor/dot-page-length-command/","api":"https://d3codex.com/api/topics/output-processor/dot-page-length-command.json"},{"slug":"output-processor/dot-page-number-command-output-processor","title":".page number command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .page number command sets the default page number to a specified integer number.","url":"https://d3codex.com/output-processor/dot-page-number-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-page-number-command-output-processor.json"},{"slug":"output-processor/dot-paging-command","title":".paging command","category":"Output Processor","categorySlug":"output-processor","summary":"The .paging command pauses at the end of each page when the output is sent to the terminal. At the end of a page of terminal output, any key can be pressed to advance to the next page.","url":"https://d3codex.com/output-processor/dot-paging-command/","api":"https://d3codex.com/api/topics/output-processor/dot-paging-command.json"},{"slug":"output-processor/dot-paragraph-command-output-processor","title":".paragraph command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .paragraph command specifies the number of spaces to indent the first line of a paragraph.","url":"https://d3codex.com/output-processor/dot-paragraph-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-paragraph-command-output-processor.json"},{"slug":"output-processor/dot-preface-command","title":".preface command","category":"Output Processor","categorySlug":"output-processor","summary":"The .preface command sets the automatic preface formatting. If a .preface command has already been issued, the page numbers resume where the last .preface command ended.","url":"https://d3codex.com/output-processor/dot-preface-command/","api":"https://d3codex.com/api/topics/output-processor/dot-preface-command.json"},{"slug":"output-processor/dot-prefix-page-command","title":".prefix page command","category":"Output Processor","categorySlug":"output-processor","summary":"The .prefix page command turns on the prefix page numbering mode, which starts numbering each chapter at page 1.","url":"https://d3codex.com/output-processor/dot-prefix-page-command/","api":"https://d3codex.com/api/topics/output-processor/dot-prefix-page-command.json"},{"slug":"output-processor/dot-print-index-command-output-processor","title":".print index command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .print index command prints the index, changes the tab settings, and begins a new page. The index is sorted in alphabetical order and printed in two columns per page. After the index is printed, it is cleared. To save the index in an item for editing, use the .save index command.","url":"https://d3codex.com/output-processor/dot-print-index-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-print-index-command-output-processor.json"},{"slug":"output-processor/dot-print-ptoc-command","title":".print ptoc command","category":"Output Processor","categorySlug":"output-processor","summary":"The .print ptoc command prints a partial table of contents. This includes topics made by these commands encountered since the last .print ptoc command:","url":"https://d3codex.com/output-processor/dot-print-ptoc-command/","api":"https://d3codex.com/api/topics/output-processor/dot-print-ptoc-command.json"},{"slug":"output-processor/dot-print-toc","title":".print toc","category":"Output Processor","categorySlug":"output-processor","summary":"The .print toc command prints the complete table of contents.","url":"https://d3codex.com/output-processor/dot-print-toc/","api":"https://d3codex.com/api/topics/output-processor/dot-print-toc.json"},{"slug":"output-processor/dot-prompt-command","title":".prompt command","category":"Output Processor","categorySlug":"output-processor","summary":"The .prompt command outputs the text on the following line to the terminal. This command is often used with the .input command to prompt for user input.","url":"https://d3codex.com/output-processor/dot-prompt-command/","api":"https://d3codex.com/api/topics/output-processor/dot-prompt-command.json"},{"slug":"output-processor/dot-read-command-output-processor","title":".read command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .read command reads an (Output processor) item and outputs the item as part of the current text. At the end of the item, the Output processor continues with the next line following the .read command.","url":"https://d3codex.com/output-processor/dot-read-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-read-command-output-processor.json"},{"slug":"output-processor/dot-readnext-command-output-processor","title":".readnext command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .readnext command reads data, one value at a time from an active list. It has an affect only if prior to entering the Output processor a select, sselect, qselect, or get-list statement has been executed.","url":"https://d3codex.com/output-processor/dot-readnext-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-readnext-command-output-processor.json"},{"slug":"output-processor/dot-readnext-null-command","title":".readnext null command","category":"Output Processor","categorySlug":"output-processor","summary":"The .readnext null command reads data from an active list. The .readnext command does not terminate if a list value does not exist.","url":"https://d3codex.com/output-processor/dot-readnext-null-command/","api":"https://d3codex.com/api/topics/output-processor/dot-readnext-null-command.json"},{"slug":"output-processor/dot-reset-command","title":".reset command","category":"Output Processor","categorySlug":"output-processor","summary":"The .reset command resets the printer to its initial state. If the printer does not support reset, this command has no affect.","url":"https://d3codex.com/output-processor/dot-reset-command/","api":"https://d3codex.com/api/topics/output-processor/dot-reset-command.json"},{"slug":"output-processor/dot-right-margin-command","title":".right margin command","category":"Output Processor","categorySlug":"output-processor","summary":"The .right margin command sets the right margin at a specific number of spaces from the right edge of the paper and remains in affect until an .indent rmargin, .right margin or .standard command is issued.","url":"https://d3codex.com/output-processor/dot-right-margin-command/","api":"https://d3codex.com/api/topics/output-processor/dot-right-margin-command.json"},{"slug":"output-processor/dot-save-contents-command","title":".save contents command","category":"Output Processor","categorySlug":"output-processor","summary":"The .save contents command saves the table of contents to a defined item-ID. The item is saved in the same file as the current document. After saving, the item can be formatted and edited to create a customized table of contents.","url":"https://d3codex.com/output-processor/dot-save-contents-command/","api":"https://d3codex.com/api/topics/output-processor/dot-save-contents-command.json"},{"slug":"output-processor/dot-save-index-command-output-processor","title":".save index command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .save index command saves the index to a defined item-ID in the same file where the Output processor document resides.","url":"https://d3codex.com/output-processor/dot-save-index-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-save-index-command-output-processor.json"},{"slug":"output-processor/dot-section-command-output-processor","title":".section command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .section command produces automatic section numbering and formatting.","url":"https://d3codex.com/output-processor/dot-section-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-section-command-output-processor.json"},{"slug":"output-processor/dot-set-chapter-command","title":".set chapter command","category":"Output Processor","categorySlug":"output-processor","summary":"The .set chapter sets the options for chapter headings. This command must precede any .chapter commands.","url":"https://d3codex.com/output-processor/dot-set-chapter-command/","api":"https://d3codex.com/api/topics/output-processor/dot-set-chapter-command.json"},{"slug":"output-processor/dot-set-section","title":".set section","category":"Output Processor","categorySlug":"output-processor","summary":"The .set section command defines the options for the section headings. This command must precede any .section commands.","url":"https://d3codex.com/output-processor/dot-set-section/","api":"https://d3codex.com/api/topics/output-processor/dot-set-section.json"},{"slug":"output-processor/dot-skip-command-output-processor","title":".skip command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .skip command outputs a specific number of blank lines using the current line spacing. The line spacing can be set either by the .spacing command or as part of the statement that invokes the Output processor. If the current line spacing is 2, a .skip command skips four lines.","url":"https://d3codex.com/output-processor/dot-skip-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-skip-command-output-processor.json"},{"slug":"output-processor/dot-space-command-output-processor","title":".space command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .space command outputs a specific number of blank lines using single-line spacing. This command is independent of the line spacing. To skip lines based on line spacing, use the .skip command.","url":"https://d3codex.com/output-processor/dot-space-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-space-command-output-processor.json"},{"slug":"output-processor/dot-spacing-command-output-processor","title":".spacing command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .spacing command sets the line spacing to a specific number of lines. This command causes blank lines to be printed in between each line of text.","url":"https://d3codex.com/output-processor/dot-spacing-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-spacing-command-output-processor.json"},{"slug":"output-processor/dot-standard-command-output-processor","title":".standard command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .standard command defines the default parameter and mode settings for the Output processor text.","url":"https://d3codex.com/output-processor/dot-standard-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-standard-command-output-processor.json"},{"slug":"output-processor/dot-subscript-command","title":".subscript command","category":"Output Processor","categorySlug":"output-processor","summary":"The .subscript command moves text down one-half line. Text remains in this position until an .xsubscript command is issued. If the printer cannot move in half lines, this command has no affect.","url":"https://d3codex.com/output-processor/dot-subscript-command/","api":"https://d3codex.com/api/topics/output-processor/dot-subscript-command.json"},{"slug":"output-processor/dot-superscript-command","title":".superscript command","category":"Output Processor","categorySlug":"output-processor","summary":"The .superscript command moves text up one-half line. If the printer cannot move in half lines, this command has no affect. To move the text back down one-half line, use the .xsuperscript command.","url":"https://d3codex.com/output-processor/dot-superscript-command/","api":"https://d3codex.com/api/topics/output-processor/dot-superscript-command.json"},{"slug":"output-processor/dot-tab-fill-command","title":".tab fill command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tab fill command defines a pattern, which is repeated to fill the line from the current position to the next tab stop. Tab stops must be set prior to using this command (see .tab set command).","url":"https://d3codex.com/output-processor/dot-tab-fill-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tab-fill-command.json"},{"slug":"output-processor/dot-tab-left-command","title":".tab left command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tab left command moves the word or specified phrase following the command to the next tab position and left-aligns the last character of the word or phrase at the tab position.","url":"https://d3codex.com/output-processor/dot-tab-left-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tab-left-command.json"},{"slug":"output-processor/dot-tab-right-command","title":".tab right command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tab right command moves the word or delimited phrase following the command to the next tab position and right-aligns the last character of the word or phrase at the tab position.","url":"https://d3codex.com/output-processor/dot-tab-right-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tab-right-command.json"},{"slug":"output-processor/dot-tab-rightm-command","title":".tab rightm command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tab rightm command right-aligns the optional text with the right margin.","url":"https://d3codex.com/output-processor/dot-tab-rightm-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tab-rightm-command.json"},{"slug":"output-processor/dot-tab-set-command","title":".tab set command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tab set command defines the location of tab stops. To move the text to these tabs, use the .tl and the .tr commands. Do not use the TAB key.","url":"https://d3codex.com/output-processor/dot-tab-set-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tab-set-command.json"},{"slug":"output-processor/dot-table-command","title":".table command","category":"Output Processor","categorySlug":"output-processor","summary":"The .table command provides automatic table numbering with sequential numbers in the form of a chapter number.","url":"https://d3codex.com/output-processor/dot-table-command/","api":"https://d3codex.com/api/topics/output-processor/dot-table-command.json"},{"slug":"output-processor/dot-tc-heading-command","title":".tc heading command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tc heading command substitutes the heading text as the header for the table of contents pages.","url":"https://d3codex.com/output-processor/dot-tc-heading-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tc-heading-command.json"},{"slug":"output-processor/dot-tcl-box-command","title":".tcl box command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tcl box command executes the specified TCL command as part of the output and draws a box around it. This command is similar to the .box command, except that the box parameters cannot be specified. The width of the box is determined by the left and right margins.","url":"https://d3codex.com/output-processor/dot-tcl-box-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tcl-box-command.json"},{"slug":"output-processor/dot-tcl-command","title":".tcl command","category":"Output Processor","categorySlug":"output-processor","summary":"The .tcl command executes the specified TCL command and inserts the output in the Output processor document. When the TCL command completes, control returns to the document and continues processing on the following line.","url":"https://d3codex.com/output-processor/dot-tcl-command/","api":"https://d3codex.com/api/topics/output-processor/dot-tcl-command.json"},{"slug":"output-processor/dot-test-page-command-output-processor","title":".test page command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .test page command tests the number of lines left on the current page and determines whether the text is output on the current or next page.","url":"https://d3codex.com/output-processor/dot-test-page-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-test-page-command-output-processor.json"},{"slug":"output-processor/dot-underline-command","title":".underline command","category":"Output Processor","categorySlug":"output-processor","summary":"The .underline command underlines the text following until an .xul or .x command is encountered. This command underlines spaces as well a words, and works on printers and terminals that support the underline function.","url":"https://d3codex.com/output-processor/dot-underline-command/","api":"https://d3codex.com/api/topics/output-processor/dot-underline-command.json"},{"slug":"output-processor/dot-underline-words-commands","title":".underline words Commands","category":"Output Processor","categorySlug":"output-processor","summary":"The .underline words command underlines all words until an .xuw command is issued.","url":"https://d3codex.com/output-processor/dot-underline-words-commands/","api":"https://d3codex.com/api/topics/output-processor/dot-underline-words-commands.json"},{"slug":"output-processor/dot-upper-case-command-output-processor","title":".upper case command (Output processor)","category":"Output Processor","categorySlug":"output-processor","summary":"The .upper case command outputs text in uppercase characters, unless specifically altered by the \\ lowercase special control function. The .end case command terminates the .upper case command.","url":"https://d3codex.com/output-processor/dot-upper-case-command-output-processor/","api":"https://d3codex.com/api/topics/output-processor/dot-upper-case-command-output-processor.json"},{"slug":"output-processor/dot-variable-columns-command","title":".variable columns command","category":"Output Processor","categorySlug":"output-processor","summary":"The .variable columns command specifies parameters for formatting in variable-width multiple columns.","url":"https://d3codex.com/output-processor/dot-variable-columns-command/","api":"https://d3codex.com/api/topics/output-processor/dot-variable-columns-command.json"},{"slug":"output-processor/dot-vmi-command","title":".vmi command","category":"Output Processor","categorySlug":"output-processor","summary":"The .vmi command specifies the amount of vertical space each line uses. The .vmi spacing is allocated in 2.08-inch increments, and is essentially the flip side of the .lpi command. For example, if the .lpi is set to 6, the equivalent .vmi setting is 8.","url":"https://d3codex.com/output-processor/dot-vmi-command/","api":"https://d3codex.com/api/topics/output-processor/dot-vmi-command.json"},{"slug":"output-processor/dot-x-command","title":".x command","category":"Output Processor","categorySlug":"output-processor","summary":"The .x command turns off the boldface, underline word, underline, and italic modes.","url":"https://d3codex.com/output-processor/dot-x-command/","api":"https://d3codex.com/api/topics/output-processor/dot-x-command.json"},{"slug":"output-processor/dot-xblock-center-command","title":".xblock center command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xblock center command turns the block center mode off.","url":"https://d3codex.com/output-processor/dot-xblock-center-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xblock-center-command.json"},{"slug":"output-processor/dot-xboldface-command","title":".xboldface command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xboldface command turns the boldface mode off.","url":"https://d3codex.com/output-processor/dot-xboldface-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xboldface-command.json"},{"slug":"output-processor/dot-xbox-command","title":".xbox command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xbox command turns off the .box command and draws the bottom line of the box.","url":"https://d3codex.com/output-processor/dot-xbox-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xbox-command.json"},{"slug":"output-processor/dot-xcap-sentences-command","title":".xcap sentences command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xcap sentences command turns off the cap sentences mode.","url":"https://d3codex.com/output-processor/dot-xcap-sentences-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xcap-sentences-command.json"},{"slug":"output-processor/dot-xcolumns-command","title":".xcolumns command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xcolumns command turns off the column heading, width, and spacing set by the .columns or .columns set commands.","url":"https://d3codex.com/output-processor/dot-xcolumns-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xcolumns-command.json"},{"slug":"output-processor/dot-xhilite-command","title":".xhilite command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xhilite command turns off the .hilite or .hi commands.","url":"https://d3codex.com/output-processor/dot-xhilite-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xhilite-command.json"},{"slug":"output-processor/dot-xindex-command","title":".xindex command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xindex command designates the end of an index topic for a topic embedded in text.","url":"https://d3codex.com/output-processor/dot-xindex-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xindex-command.json"},{"slug":"output-processor/dot-xitalics-command","title":".xitalics command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xitalics command turns off the italics mode.","url":"https://d3codex.com/output-processor/dot-xitalics-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xitalics-command.json"},{"slug":"output-processor/dot-xjustify-command","title":".xjustify command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xjustify command turns off the justify mode.","url":"https://d3codex.com/output-processor/dot-xjustify-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xjustify-command.json"},{"slug":"output-processor/dot-xpaging-command","title":".xpaging command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xpaging command turns off the paging option and causes the output to scroll down the terminal.","url":"https://d3codex.com/output-processor/dot-xpaging-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xpaging-command.json"},{"slug":"output-processor/dot-xparagraph","title":".xparagraph","category":"Output Processor","categorySlug":"output-processor","summary":"The .xparagraph command turns off the paragraph mode.","url":"https://d3codex.com/output-processor/dot-xparagraph/","api":"https://d3codex.com/api/topics/output-processor/dot-xparagraph.json"},{"slug":"output-processor/dot-xpreface-command","title":".xpreface command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xpreface command turns off the preface mode.","url":"https://d3codex.com/output-processor/dot-xpreface-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xpreface-command.json"},{"slug":"output-processor/dot-xprefix-page-command","title":".xprefix page command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xprefix page command turns off the prefix page mode.","url":"https://d3codex.com/output-processor/dot-xprefix-page-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xprefix-page-command.json"},{"slug":"output-processor/dot-xsubscript-command","title":".xsubscript command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xsubscript command turns off the subscript mode.","url":"https://d3codex.com/output-processor/dot-xsubscript-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xsubscript-command.json"},{"slug":"output-processor/dot-xsuperscript-command","title":".xsuperscript command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xsuperscript command turns the superscript mode off.","url":"https://d3codex.com/output-processor/dot-xsuperscript-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xsuperscript-command.json"},{"slug":"output-processor/dot-xul-command","title":".xul command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xul command turns off the underline mode.","url":"https://d3codex.com/output-processor/dot-xul-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xul-command.json"},{"slug":"output-processor/dot-xuw-command","title":".xuw command","category":"Output Processor","categorySlug":"output-processor","summary":"The .xuw command turns off the .underline words command.","url":"https://d3codex.com/output-processor/dot-xuw-command/","api":"https://d3codex.com/api/topics/output-processor/dot-xuw-command.json"},{"slug":"output-processor/output-processor","title":"Output processor","category":"Output Processor","categorySlug":"output-processor","summary":"This section discusses the Output processor.","url":"https://d3codex.com/output-processor/output-processor/","api":"https://d3codex.com/api/topics/output-processor/output-processor.json"},{"slug":"output-processor/output-processor-commands","title":"Output processor commands","category":"Output Processor","categorySlug":"output-processor","summary":"An Output processor command is preceded by a space and a period (the period is part of the command) followed by the characters that make up the command. The Output processor command ends with a space, another Output processor command, or an attribute mark. The Output processor commands are not shown in the formatted and printed text.","url":"https://d3codex.com/output-processor/output-processor-commands/","api":"https://d3codex.com/api/topics/output-processor/output-processor-commands.json"},{"slug":"output-processor/output-processor-overview","title":"Output processor overview","category":"Output Processor","categorySlug":"output-processor","summary":"The Output processor formats and prints text from commands embedded in the textual data.","url":"https://d3codex.com/output-processor/output-processor-overview/","api":"https://d3codex.com/api/topics/output-processor/output-processor-overview.json"},{"slug":"pickbasic-flashbasic/abort-statement","title":"abort statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The abort statement immediately stops program execution and unconditionally returns to the TCL command prompt.","url":"https://d3codex.com/pickbasic-flashbasic/abort-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/abort-statement.json"},{"slug":"pickbasic-flashbasic/abs-function","title":"abs() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The abs() function returns the absolute (positive) portion of the integer number derived from the given numeric expression.","url":"https://d3codex.com/pickbasic-flashbasic/abs-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/abs-function.json"},{"slug":"pickbasic-flashbasic/access-function","title":"access() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The access() function provides data about the AQL or Update processor environments when the program is called from a dictionary.","url":"https://d3codex.com/pickbasic-flashbasic/access-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/access-function.json"},{"slug":"pickbasic-flashbasic/accessing-vme-resources-from-a-rule-module","title":"Accessing VME resources from a rule module","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"There are several important rules to observe when running a FlashBASIC module, either as a Visual Basic rule module object from a subroutine called by such an object, or from a trigger.","url":"https://d3codex.com/pickbasic-flashbasic/accessing-vme-resources-from-a-rule-module/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/accessing-vme-resources-from-a-rule-module.json"},{"slug":"pickbasic-flashbasic/alpha-function","title":"alpha() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The alpha() function evaluates the expression and returns 1 (true) if every character in the string is alphabetical (that is, a—z upper and lowercase), or 0 (false) if any character is nonalphabetical.","url":"https://d3codex.com/pickbasic-flashbasic/alpha-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/alpha-function.json"},{"slug":"pickbasic-flashbasic/ampersand-logical-operator","title":"& logical operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The and boolean operator indicates that both components of a logical expression must be true.","url":"https://d3codex.com/pickbasic-flashbasic/ampersand-logical-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ampersand-logical-operator.json"},{"slug":"pickbasic-flashbasic/and-logical-operator","title":"and logical operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The and logical operator indicates that both components of a logical expression must be true.","url":"https://d3codex.com/pickbasic-flashbasic/and-logical-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/and-logical-operator.json"},{"slug":"pickbasic-flashbasic/arithmetic-expressions","title":"Arithmetic expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Arithmetic expressions perform mathematical calculations on any set of operand expressions.","url":"https://d3codex.com/pickbasic-flashbasic/arithmetic-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/arithmetic-expressions.json"},{"slug":"pickbasic-flashbasic/arithmetic-operators","title":"Arithmetic operators","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Arithmetic operators add, subtract, multiply, and divide numeric operands in arithmetic expressions.","url":"https://d3codex.com/pickbasic-flashbasic/arithmetic-operators/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/arithmetic-operators.json"},{"slug":"pickbasic-flashbasic/array-references","title":"Array references","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Dimensioned and Dynamic arrays can be referenced in BASIC programs.","url":"https://d3codex.com/pickbasic-flashbasic/array-references/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/array-references.json"},{"slug":"pickbasic-flashbasic/array-variable","title":"Array variable","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"An array variable references a dynamic or dimensioned array.","url":"https://d3codex.com/pickbasic-flashbasic/array-variable/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/array-variable.json"},{"slug":"pickbasic-flashbasic/arrays","title":"Arrays","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Pick BASIC has two types of arrays:","url":"https://d3codex.com/pickbasic-flashbasic/arrays/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/arrays.json"},{"slug":"pickbasic-flashbasic/arrays-and-relational-expressions","title":"Arrays and relational expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Individual elements of dimensioned and dynamic arrays are compared in relational expressions using the standard syntax.","url":"https://d3codex.com/pickbasic-flashbasic/arrays-and-relational-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/arrays-and-relational-expressions.json"},{"slug":"pickbasic-flashbasic/ascii-function","title":"ascii() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ascii() function converts a string of EBCDIC-encoded characters into their equivalent ASCII values.","url":"https://d3codex.com/pickbasic-flashbasic/ascii-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ascii-function.json"},{"slug":"pickbasic-flashbasic/assigned-function","title":"assigned() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The assigned() function determines if the variable has been assigned a value.","url":"https://d3codex.com/pickbasic-flashbasic/assigned-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/assigned-function.json"},{"slug":"pickbasic-flashbasic/assignment","title":"Assignment","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Assignment is the process of assigning the value of an expression to a variable.","url":"https://d3codex.com/pickbasic-flashbasic/assignment/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/assignment.json"},{"slug":"pickbasic-flashbasic/asterisk-arithmetic-operator","title":"* arithmetic operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The * (asterisk) arithmetic operator is a mathematical operator indicating a multiply operation.","url":"https://d3codex.com/pickbasic-flashbasic/asterisk-arithmetic-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/asterisk-arithmetic-operator.json"},{"slug":"pickbasic-flashbasic/asterisk-equals-assignment-operator","title":"*= assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The *= assignment operator multiplies a numeric expression and assigns it to the variable.","url":"https://d3codex.com/pickbasic-flashbasic/asterisk-equals-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/asterisk-equals-assignment-operator.json"},{"slug":"pickbasic-flashbasic/asterisk-statement","title":"* statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The * (asterisk) statement is used as a remark. Text after this statement is ignored.","url":"https://d3codex.com/pickbasic-flashbasic/asterisk-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/asterisk-statement.json"},{"slug":"pickbasic-flashbasic/at-parenthesis-function","title":"@() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The @() function provides a standard means of performing control functions on a wide array of terminals.","url":"https://d3codex.com/pickbasic-flashbasic/at-parenthesis-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/at-parenthesis-function.json"},{"slug":"pickbasic-flashbasic/attribute-count-expression","title":"Attribute count expression","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"An attribute count expression (ac expression) is any numeric constant or any arithmetic, logical, or string expression that evaluates to a valid numeric value, used to reference an attribute count within statements, functions, and arrays or string variable.","url":"https://d3codex.com/pickbasic-flashbasic/attribute-count-expression/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/attribute-count-expression.json"},{"slug":"pickbasic-flashbasic/aux-statement","title":"aux statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The aux statement enables or disables spooling to the auxiliary port.","url":"https://d3codex.com/pickbasic-flashbasic/aux-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/aux-statement.json"},{"slug":"pickbasic-flashbasic/backslash-arithmetic-operator","title":"\\ arithmetic operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The \\ operator (also called the remainder operator) calculates the remainder of dividing the dividend by the divisor (otherwise known as the modulo).","url":"https://d3codex.com/pickbasic-flashbasic/backslash-arithmetic-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/backslash-arithmetic-operator.json"},{"slug":"pickbasic-flashbasic/backslash-equals-assignment-operator","title":"\\= assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The \\= assignment operator divides a variable by a given numeric expression and assigns the remainder (modulo) to the variable.","url":"https://d3codex.com/pickbasic-flashbasic/backslash-equals-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/backslash-equals-assignment-operator.json"},{"slug":"pickbasic-flashbasic/backslash-reserved-character","title":"\\ reserved character","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The \\ reserved character marks the beginning or ending of a literal string in FlashBASIC or BASIC.","url":"https://d3codex.com/pickbasic-flashbasic/backslash-reserved-character/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/backslash-reserved-character.json"},{"slug":"pickbasic-flashbasic/basic","title":"BASIC","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"BASIC is a high-level programming language that is an extension of the Dartmouth BASIC (Beginners All-purpose Symbolic Instruction Code) language. It is the principal programming language bundled with the D3 system and was designed for the implementation of application requirements not inherent in standard D3 functionality.","url":"https://d3codex.com/pickbasic-flashbasic/basic/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic.json"},{"slug":"pickbasic-flashbasic/basic-clauses","title":"BASIC clauses","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following BASIC clauses are available.","url":"https://d3codex.com/pickbasic-flashbasic/basic-clauses/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-clauses.json"},{"slug":"pickbasic-flashbasic/basic-functions","title":"BASIC functions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following BASIC functions are available.","url":"https://d3codex.com/pickbasic-flashbasic/basic-functions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-functions.json"},{"slug":"pickbasic-flashbasic/basic-operators","title":"BASIC operators","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following BASIC operators are available.","url":"https://d3codex.com/pickbasic-flashbasic/basic-operators/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-operators.json"},{"slug":"pickbasic-flashbasic/basic-overview","title":"BASIC overview","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"This general overview includes information on these topics:","url":"https://d3codex.com/pickbasic-flashbasic/basic-overview/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-overview.json"},{"slug":"pickbasic-flashbasic/basic-reserved-characters","title":"BASIC reserved characters","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following BASIC reserved characters are available.","url":"https://d3codex.com/pickbasic-flashbasic/basic-reserved-characters/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-reserved-characters.json"},{"slug":"pickbasic-flashbasic/basic-screen-utilities","title":"BASIC screen utilities","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Screen utilities are used to display formatted menus.","url":"https://d3codex.com/pickbasic-flashbasic/basic-screen-utilities/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-screen-utilities.json"},{"slug":"pickbasic-flashbasic/basic-statements","title":"BASIC statements","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"","url":"https://d3codex.com/pickbasic-flashbasic/basic-statements/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-statements.json"},{"slug":"pickbasic-flashbasic/basic-symbolic-debugger","title":"BASIC symbolic debugger","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The BASIC symbolic debugger facilitates the debugging of new BASIC programs and the maintenance of existing BASIC programs. The BASIC debugger requires sys2 privileges and has these general capabilities:","url":"https://d3codex.com/pickbasic-flashbasic/basic-symbolic-debugger/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-symbolic-debugger.json"},{"slug":"pickbasic-flashbasic/basic-user-exits","title":"BASIC user exits","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"User exits allow calling direct system code from a BASIC oconv or iconv function. Many of the functions performed by user exits can be achieved by using the system() function or the execute statement with the appropriate TCL command or BASIC statement.","url":"https://d3codex.com/pickbasic-flashbasic/basic-user-exits/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/basic-user-exits.json"},{"slug":"pickbasic-flashbasic/begin-case-statement","title":"begin case statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The begin case statement starts a case construct.","url":"https://d3codex.com/pickbasic-flashbasic/begin-case-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/begin-case-statement.json"},{"slug":"pickbasic-flashbasic/begin-work-statement","title":"begin work statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The begin work statement starts a transaction.","url":"https://d3codex.com/pickbasic-flashbasic/begin-work-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/begin-work-statement.json"},{"slug":"pickbasic-flashbasic/block-unblock-statements","title":"block/unblock statements","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Basic provides facilities for converting between variable length data structures and fixed length data structures.","url":"https://d3codex.com/pickbasic-flashbasic/block-unblock-statements/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/block-unblock-statements.json"},{"slug":"pickbasic-flashbasic/boolean-evaluation","title":"Boolean evaluation","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Traditionally, the result of a logical or Boolean expression is considered true if it evaluates to 1 and false if it evaluates to 0.","url":"https://d3codex.com/pickbasic-flashbasic/boolean-evaluation/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/boolean-evaluation.json"},{"slug":"pickbasic-flashbasic/brackets-reserved-characters","title":"[] reserved characters","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The [] reserved characters perform substring extraction, assignment, and field store.","url":"https://d3codex.com/pickbasic-flashbasic/brackets-reserved-characters/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/brackets-reserved-characters.json"},{"slug":"pickbasic-flashbasic/break-statement","title":"break statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The break statement enables or disables the BREAK key.","url":"https://d3codex.com/pickbasic-flashbasic/break-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/break-statement.json"},{"slug":"pickbasic-flashbasic/call-statement","title":"call statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The call statement transfers control to an external FlashBASIC or BASIC subroutine and optionally passes a list of arguments to it.","url":"https://d3codex.com/pickbasic-flashbasic/call-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/call-statement.json"},{"slug":"pickbasic-flashbasic/capturing-clause","title":"capturing clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The capturing clause resumes the capturing effect from the previous execute...capturing statements in a FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/capturing-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/capturing-clause.json"},{"slug":"pickbasic-flashbasic/capturing-statement","title":"capturing statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The capturing statement resumes the capturing effect from the previous execute...capturing statements in a FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/capturing-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/capturing-statement.json"},{"slug":"pickbasic-flashbasic/caret-arithmetic-operator","title":"^ arithmetic operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ^ symbol arithmetic operator is an alternate means of indicating an exponentiation operation on a specific numeric expression.","url":"https://d3codex.com/pickbasic-flashbasic/caret-arithmetic-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/caret-arithmetic-operator.json"},{"slug":"pickbasic-flashbasic/case-statement","title":"case statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The case statement delineates a conditional case construct.","url":"https://d3codex.com/pickbasic-flashbasic/case-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/case-statement.json"},{"slug":"pickbasic-flashbasic/casing-statement","title":"casing statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The casing statement toggles case sensitivity relative to input data and string comparisons in the current program and any called subroutines.","url":"https://d3codex.com/pickbasic-flashbasic/casing-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/casing-statement.json"},{"slug":"pickbasic-flashbasic/cat-relational-operator","title":"cat relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The cat relational operator concatenates strings in an expression.","url":"https://d3codex.com/pickbasic-flashbasic/cat-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cat-relational-operator.json"},{"slug":"pickbasic-flashbasic/cataloging-a-flashbasic-module","title":"Cataloging a FlashBASIC Module","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Cataloging makes code easier to locate. It is not necessary to catalog a BASIC module to run or call it. Cataloging does not affect performance since the object code is always loaded in a dynamically extensible shared memory segment.","url":"https://d3codex.com/pickbasic-flashbasic/cataloging-a-flashbasic-module/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cataloging-a-flashbasic-module.json"},{"slug":"pickbasic-flashbasic/cfunction-statement","title":"cfunction statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The cfunction statement provides access to C libraries from BASIC.","url":"https://d3codex.com/pickbasic-flashbasic/cfunction-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cfunction-statement.json"},{"slug":"pickbasic-flashbasic/chain-statement","title":"chain statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The chain statement transfers processing control to TCL, which interprets and executes the statement defined in the expression.","url":"https://d3codex.com/pickbasic-flashbasic/chain-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/chain-statement.json"},{"slug":"pickbasic-flashbasic/change-function","title":"change() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The change() function searches a str.exp for the search.str. If the search.str is at the start occurrence, then replacement.str replaces search.str for the amount specified in occurrences.","url":"https://d3codex.com/pickbasic-flashbasic/change-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/change-function.json"},{"slug":"pickbasic-flashbasic/char-function","title":"char() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The char() function converts a number between 0 and 255 to its corresponding ASCII character equivalent.","url":"https://d3codex.com/pickbasic-flashbasic/char-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/char-function.json"},{"slug":"pickbasic-flashbasic/clear-statement","title":"clear statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The clear statement sets all local and common variables to 0 in a main program.","url":"https://d3codex.com/pickbasic-flashbasic/clear-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/clear-statement.json"},{"slug":"pickbasic-flashbasic/cleardata-statement","title":"cleardata statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The cleardata statement clears the data stack.","url":"https://d3codex.com/pickbasic-flashbasic/cleardata-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cleardata-statement.json"},{"slug":"pickbasic-flashbasic/clearfile-statement","title":"clearfile statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The clearfile statement deletes all items in the specified file variable previously opened with an open statement.","url":"https://d3codex.com/pickbasic-flashbasic/clearfile-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/clearfile-statement.json"},{"slug":"pickbasic-flashbasic/clearselect-statement","title":"clearselect statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The clearselect statement clears the active select-list specified by the list.var and releases all overflow associated with that list. Any external select-list is also cleared if the list variable is not specified.","url":"https://d3codex.com/pickbasic-flashbasic/clearselect-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/clearselect-statement.json"},{"slug":"pickbasic-flashbasic/close-statement","title":"close statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The close statement closes the file identified by file.var. If file.var is not specified, the file referenced by the default file.var is closed.","url":"https://d3codex.com/pickbasic-flashbasic/close-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/close-statement.json"},{"slug":"pickbasic-flashbasic/cocreateobject-interface","title":"%CoCreateObject interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Call to create a COM Object.","url":"https://d3codex.com/pickbasic-flashbasic/cocreateobject-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cocreateobject-interface.json"},{"slug":"pickbasic-flashbasic/cogetdispatch-interface","title":"%CoGetDispatch interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Call a to get an IDispatch.","url":"https://d3codex.com/pickbasic-flashbasic/cogetdispatch-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cogetdispatch-interface.json"},{"slug":"pickbasic-flashbasic/cogetexception-interface","title":"%CoGetException interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Get error description.","url":"https://d3codex.com/pickbasic-flashbasic/cogetexception-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cogetexception-interface.json"},{"slug":"pickbasic-flashbasic/coinitialize-interface","title":"%CoInitialize interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Call to initialize the COM library.","url":"https://d3codex.com/pickbasic-flashbasic/coinitialize-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/coinitialize-interface.json"},{"slug":"pickbasic-flashbasic/coinvoke-interface","title":"%CoInvoke interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Call a method.","url":"https://d3codex.com/pickbasic-flashbasic/coinvoke-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/coinvoke-interface.json"},{"slug":"pickbasic-flashbasic/col1-function","title":"col1() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The col1() function returns the numeric column position of the character immediately preceding the substring retrieved in the most recently executed field() function.","url":"https://d3codex.com/pickbasic-flashbasic/col1-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/col1-function.json"},{"slug":"pickbasic-flashbasic/col2-function","title":"col2() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The col2() function returns the numeric column position of the character following the substring retrieved in the most recently executed field() function.","url":"https://d3codex.com/pickbasic-flashbasic/col2-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/col2-function.json"},{"slug":"pickbasic-flashbasic/colon-equals-assignment-operator","title":":= assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The := assignment operator concatenates a string to a variable and assigns it back to the given variable.","url":"https://d3codex.com/pickbasic-flashbasic/colon-equals-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/colon-equals-assignment-operator.json"},{"slug":"pickbasic-flashbasic/colon-relational-operator","title":": relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The : (colon) relational operator concatenates strings in an assignment statement or, when the : displays at the end of a print or crt expression, suppresses the automatic CR/LF combination, thus holding the current print/display position. It is also used as a token within the input @ statement.","url":"https://d3codex.com/pickbasic-flashbasic/colon-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/colon-relational-operator.json"},{"slug":"pickbasic-flashbasic/comma-reserved-character","title":", reserved character","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The , (comma) reserved character several purposes:","url":"https://d3codex.com/pickbasic-flashbasic/comma-reserved-character/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/comma-reserved-character.json"},{"slug":"pickbasic-flashbasic/commit-work-statement","title":"commit work statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The commit work operation commits a transaction.","url":"https://d3codex.com/pickbasic-flashbasic/commit-work-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/commit-work-statement.json"},{"slug":"pickbasic-flashbasic/common-statement","title":"common statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The common statement declares data elements to share among different FlashBASIC or BASIC modules.","url":"https://d3codex.com/pickbasic-flashbasic/common-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/common-statement.json"},{"slug":"pickbasic-flashbasic/compare-statement","title":"compare statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The compare statement compares two dynamic arrays.","url":"https://d3codex.com/pickbasic-flashbasic/compare-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/compare-statement.json"},{"slug":"pickbasic-flashbasic/compile-stamps","title":"Compile stamps","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Compile stamp items contain descriptive internal information about programs compiled for BASIC.","url":"https://d3codex.com/pickbasic-flashbasic/compile-stamps/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/compile-stamps.json"},{"slug":"pickbasic-flashbasic/compiler-directives","title":"Compiler directives","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Compiler directives control how a program is compiled. D3 supports a number of compiler directives to affect how a program is compiled.","url":"https://d3codex.com/pickbasic-flashbasic/compiler-directives/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/compiler-directives.json"},{"slug":"pickbasic-flashbasic/compiling-programs","title":"Compiling programs","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Compiling a BASIC program converts the source code into a list of binary instructions called object code.","url":"https://d3codex.com/pickbasic-flashbasic/compiling-programs/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/compiling-programs.json"},{"slug":"pickbasic-flashbasic/continue-statement","title":"continue statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The continue statement restarts a loop that is under for...next or loop...repeat control.","url":"https://d3codex.com/pickbasic-flashbasic/continue-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/continue-statement.json"},{"slug":"pickbasic-flashbasic/conversion-expression","title":"Conversion expression","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A conversion expression is any function that evaluates to any of the valid processing codes listed below in the See also section.","url":"https://d3codex.com/pickbasic-flashbasic/conversion-expression/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/conversion-expression.json"},{"slug":"pickbasic-flashbasic/convert-function","title":"convert() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The convert() function searches a given variable and replaces each occurrence of a character by another.","url":"https://d3codex.com/pickbasic-flashbasic/convert-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/convert-function.json"},{"slug":"pickbasic-flashbasic/convert-statement","title":"convert statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The convert statement searches a given variable and replaces each occurrence of a character by another.","url":"https://d3codex.com/pickbasic-flashbasic/convert-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/convert-statement.json"},{"slug":"pickbasic-flashbasic/copropertyget-interface","title":"%CoPropertyGet interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Call a Property Get.","url":"https://d3codex.com/pickbasic-flashbasic/copropertyget-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/copropertyget-interface.json"},{"slug":"pickbasic-flashbasic/copropertyput-interface","title":"%CoPropertyPut interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Call a Property Put.","url":"https://d3codex.com/pickbasic-flashbasic/copropertyput-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/copropertyput-interface.json"},{"slug":"pickbasic-flashbasic/coqueryinterface-interface","title":"%CoQueryInterface interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Query IUnknown for IDispatch interface.","url":"https://d3codex.com/pickbasic-flashbasic/coqueryinterface-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/coqueryinterface-interface.json"},{"slug":"pickbasic-flashbasic/coquerymethod-interface","title":"%CoQueryMethod interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Query for a method.","url":"https://d3codex.com/pickbasic-flashbasic/coquerymethod-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/coquerymethod-interface.json"},{"slug":"pickbasic-flashbasic/corelease-interface","title":"%CoRelease interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Release a dispatch or COM object when done.","url":"https://d3codex.com/pickbasic-flashbasic/corelease-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/corelease-interface.json"},{"slug":"pickbasic-flashbasic/cos-function","title":"cos() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The cos() function calculates the trigonometric cosine of an angle of a specified numeric expression in the range 0 to 360 degrees.","url":"https://d3codex.com/pickbasic-flashbasic/cos-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/cos-function.json"},{"slug":"pickbasic-flashbasic/couninitialize-interface","title":"%CoUninitialize interface","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Uninitialize the COM library.","url":"https://d3codex.com/pickbasic-flashbasic/couninitialize-interface/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/couninitialize-interface.json"},{"slug":"pickbasic-flashbasic/count-function","title":"count() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The count() function returns the number of occurrences of str.exp2 within str.exp1.","url":"https://d3codex.com/pickbasic-flashbasic/count-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/count-function.json"},{"slug":"pickbasic-flashbasic/creating-a-flashbasic-module","title":"Creating a FlashBASIC module","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A BASIC module is a subroutine that does no I/O and is call from an external source. (It is possible to post-compile an object without the source.)","url":"https://d3codex.com/pickbasic-flashbasic/creating-a-flashbasic-module/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/creating-a-flashbasic-module.json"},{"slug":"pickbasic-flashbasic/creating-user-defined-c-functions-d3-unix","title":"Creating user-defined C functions (D3 UNIX)","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A user-defined C function can be incorporated in the D3 monitor, thus making C functions available to all applications running on the system.","url":"https://d3codex.com/pickbasic-flashbasic/creating-user-defined-c-functions-d3-unix/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/creating-user-defined-c-functions-d3-unix.json"},{"slug":"pickbasic-flashbasic/creating-user-defined-c-functions-d3-windows","title":"Creating user-defined C functions (D3 Windows)","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The example below describes creating, adding, removing, loading and unloading a C DLL function in Visual Studio 2008.","url":"https://d3codex.com/pickbasic-flashbasic/creating-user-defined-c-functions-d3-windows/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/creating-user-defined-c-functions-d3-windows.json"},{"slug":"pickbasic-flashbasic/crt-statement","title":"crt statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The crt statement outputs unconditionally to the terminal display, regardless of whether or not the printer on condition is in effect.","url":"https://d3codex.com/pickbasic-flashbasic/crt-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/crt-statement.json"},{"slug":"pickbasic-flashbasic/data-representation","title":"Data representation","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Data representation refers to the data types employed in BASIC. There are primarily two types of data:","url":"https://d3codex.com/pickbasic-flashbasic/data-representation/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/data-representation.json"},{"slug":"pickbasic-flashbasic/data-statement","title":"data statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The data statement queues responses for use by subsequent input requests initiated from chain, enter, execute, or input statements. The data is taken from the queue in the order in which it was added.","url":"https://d3codex.com/pickbasic-flashbasic/data-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/data-statement.json"},{"slug":"pickbasic-flashbasic/date-function","title":"date() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The date() function returns the current system date in internal format as an integer number representing the number of days that have elapsed since December 31, 1967 (day 0 on the D3 calendar).","url":"https://d3codex.com/pickbasic-flashbasic/date-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/date-function.json"},{"slug":"pickbasic-flashbasic/dcount-function","title":"dcount() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The dcount() function returns the number of occurrences of the delimiter specified in str.exp2 within str.exp1, plus one.","url":"https://d3codex.com/pickbasic-flashbasic/dcount-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dcount-function.json"},{"slug":"pickbasic-flashbasic/debug-statement","title":"debug statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The debug statement temporarily suspends execution of a FlashBASIC or BASIC program and invokes the FlashBASIC or BASIC debugger.","url":"https://d3codex.com/pickbasic-flashbasic/debug-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/debug-statement.json"},{"slug":"pickbasic-flashbasic/default-file-variables","title":"Default File Variables","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following statements make use of a feature known as default file variables:","url":"https://d3codex.com/pickbasic-flashbasic/default-file-variables/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/default-file-variables.json"},{"slug":"pickbasic-flashbasic/deffun-statement","title":"deffun statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Use the deffun statement to define a user-written external function (for example, an external sub-routine invoked using CALL).","url":"https://d3codex.com/pickbasic-flashbasic/deffun-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/deffun-statement.json"},{"slug":"pickbasic-flashbasic/define-directive","title":"$DEFINE directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $DEFINE directive supplies replacement text for a symbol and defines a symbol used to control the compilation of the program.","url":"https://d3codex.com/pickbasic-flashbasic/define-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/define-directive.json"},{"slug":"pickbasic-flashbasic/del-statement","title":"del statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The del statement provides an alternate to the delete() function for deleting a location from a dynamic array.","url":"https://d3codex.com/pickbasic-flashbasic/del-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/del-statement.json"},{"slug":"pickbasic-flashbasic/delete-function","title":"delete() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The delete() function removes a specific attribute, value, or subvalue from a dimensioned or dynamic array.","url":"https://d3codex.com/pickbasic-flashbasic/delete-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/delete-function.json"},{"slug":"pickbasic-flashbasic/delete-statement","title":"delete statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The delete statement removes a specific item from a file.","url":"https://d3codex.com/pickbasic-flashbasic/delete-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/delete-statement.json"},{"slug":"pickbasic-flashbasic/dimension-statement","title":"dimension statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The dimension statement establishes a specific number of storage locations for a matrix of variables.","url":"https://d3codex.com/pickbasic-flashbasic/dimension-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dimension-statement.json"},{"slug":"pickbasic-flashbasic/do-clause","title":"do clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The optional do clause is used with the loop statement.","url":"https://d3codex.com/pickbasic-flashbasic/do-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/do-clause.json"},{"slug":"pickbasic-flashbasic/dollar-asterisk-directive","title":"$* directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $* (asterisk) directive allows a comment to be embedded directly into the program’s object code at compilation.","url":"https://d3codex.com/pickbasic-flashbasic/dollar-asterisk-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dollar-asterisk-directive.json"},{"slug":"pickbasic-flashbasic/dollar-chain-directive","title":"$chain directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $chain directive continues FlashBASIC or BASIC compilation in a different source item.","url":"https://d3codex.com/pickbasic-flashbasic/dollar-chain-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dollar-chain-directive.json"},{"slug":"pickbasic-flashbasic/dollar-chain-statement","title":"$chain statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $chain statement continues FlashBASIC or BASIC compilation in a different source item.","url":"https://d3codex.com/pickbasic-flashbasic/dollar-chain-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dollar-chain-statement.json"},{"slug":"pickbasic-flashbasic/dollar-include-directive","title":"$include directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $include directive inserts FlashBASIC or BASIC code from a separate item (known as an include item) to be compiled as part of the object module of the current program or subroutine. The original source program is not altered.","url":"https://d3codex.com/pickbasic-flashbasic/dollar-include-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dollar-include-directive.json"},{"slug":"pickbasic-flashbasic/dollar-include-statement","title":"$include statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $include statement inserts FlashBASIC or BASIC code from a separate item (known as an include item) to be compiled as part of the object module of the current program or subroutine. The original source program is not altered.","url":"https://d3codex.com/pickbasic-flashbasic/dollar-include-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dollar-include-statement.json"},{"slug":"pickbasic-flashbasic/dollar-options-directive","title":"$options directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $options directive sets compatibility options for the FlashBASIC or BASIC compiler.","url":"https://d3codex.com/pickbasic-flashbasic/dollar-options-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dollar-options-directive.json"},{"slug":"pickbasic-flashbasic/dollar-options-statement","title":"$options statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $options statement sets compatibility options for the FlashBASIC or BASIC compiler.","url":"https://d3codex.com/pickbasic-flashbasic/dollar-options-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dollar-options-statement.json"},{"slug":"pickbasic-flashbasic/dquote-function","title":"dquote() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The dquote() function extracts a double-quoted string from str.exp.","url":"https://d3codex.com/pickbasic-flashbasic/dquote-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dquote-function.json"},{"slug":"pickbasic-flashbasic/dtx-function","title":"dtx() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The dtx() function converts a given decimal number to its corresponding hexadecimal equivalent. The number is first converted to an integer by truncating the fractional part.","url":"https://d3codex.com/pickbasic-flashbasic/dtx-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/dtx-function.json"},{"slug":"pickbasic-flashbasic/ebcdic-function","title":"ebcdic() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ebcdic() function converts a string of ASCII-encoded characters into their equivalent EBCDIC values.","url":"https://d3codex.com/pickbasic-flashbasic/ebcdic-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ebcdic-function.json"},{"slug":"pickbasic-flashbasic/echo-statement","title":"echo statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The echo statement toggles terminal echo on or off.","url":"https://d3codex.com/pickbasic-flashbasic/echo-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/echo-statement.json"},{"slug":"pickbasic-flashbasic/else-clause","title":"else clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The else clause is the inline clause for the if statement to execute when it evaluates to false.","url":"https://d3codex.com/pickbasic-flashbasic/else-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/else-clause.json"},{"slug":"pickbasic-flashbasic/end-case-statement","title":"end case statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The end case statement terminates case construct.","url":"https://d3codex.com/pickbasic-flashbasic/end-case-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/end-case-statement.json"},{"slug":"pickbasic-flashbasic/end-statement","title":"end statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The end statement indicates both the end of a series of statements executed conditionally from a then or else condition or the physical end of the program.","url":"https://d3codex.com/pickbasic-flashbasic/end-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/end-statement.json"},{"slug":"pickbasic-flashbasic/enter-statement","title":"enter statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The enter statement transfers control to another cataloged FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/enter-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/enter-statement.json"},{"slug":"pickbasic-flashbasic/environment-variables-in-triggers","title":"Environment variables in triggers","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The environment variables that are available when run from a trigger are described in this topic.","url":"https://d3codex.com/pickbasic-flashbasic/environment-variables-in-triggers/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/environment-variables-in-triggers.json"},{"slug":"pickbasic-flashbasic/eq-assignment-operator","title":"eq assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The eq assignment operator represents either the assignment operator in an assignment statement or a relational operator in a conditional expression.","url":"https://d3codex.com/pickbasic-flashbasic/eq-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/eq-assignment-operator.json"},{"slug":"pickbasic-flashbasic/equals-assignment-operator","title":"= assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The = assignment operator represents either the assignment operator in an assignment statement or a relational operator in a conditional expression.","url":"https://d3codex.com/pickbasic-flashbasic/equals-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/equals-assignment-operator.json"},{"slug":"pickbasic-flashbasic/equate-statement","title":"equate statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The equate statement is a compiler directive that declares a constant at compile time or a synonym of another variable or array element.","url":"https://d3codex.com/pickbasic-flashbasic/equate-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/equate-statement.json"},{"slug":"pickbasic-flashbasic/ereplace-function","title":"ereplace() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ereplace() function searches a str.exp for the search.str. If the search.str is at the start occurrence, then replacement.str replaces search.str for the amount specified in occurrences.","url":"https://d3codex.com/pickbasic-flashbasic/ereplace-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ereplace-function.json"},{"slug":"pickbasic-flashbasic/error-condition","title":"Error condition","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"An error condition is the process state that occurs when a program encounters a condition that cannot be resolved, forcing an abort to the FlashBASIC or BASIC debugger. For example, if a reference is made to a dimensioned array subscript less than 1 or greater than the number defined in the dim statement a nonrecoverable error occurs.","url":"https://d3codex.com/pickbasic-flashbasic/error-condition/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/error-condition.json"},{"slug":"pickbasic-flashbasic/error-function","title":"error() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The error() function retrieves the TCL command used to activate the program and loads it into a specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/error-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/error-function.json"},{"slug":"pickbasic-flashbasic/error-logging","title":"Error logging","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"This topic describes how to record compiling errors when using FlashBASIC. Errors encountered during runtime are logged to the DM,RUNTIME-ERRORS file. These errors can be displayed by using the TCL command LIST-RUNTIME-ERRORS","url":"https://d3codex.com/pickbasic-flashbasic/error-logging/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/error-logging.json"},{"slug":"pickbasic-flashbasic/error-statement","title":"error statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The error statement displays the error message from the messages file and continues execution of the program.","url":"https://d3codex.com/pickbasic-flashbasic/error-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/error-statement.json"},{"slug":"pickbasic-flashbasic/exchange-function","title":"exchange() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The exchange() function replaces the character specified as a hexadecimal string in str.exp1 with the character specified as a hexadecimal string in str.exp2.","url":"https://d3codex.com/pickbasic-flashbasic/exchange-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/exchange-function.json"},{"slug":"pickbasic-flashbasic/exclamation-logical-operator","title":"! logical operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ! logical operator indicates an or operation in a logical expression.","url":"https://d3codex.com/pickbasic-flashbasic/exclamation-logical-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/exclamation-logical-operator.json"},{"slug":"pickbasic-flashbasic/exclamation-statement","title":"! statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ! statement indicates that the text following the ! is a comment. This works the same as the remark statement.","url":"https://d3codex.com/pickbasic-flashbasic/exclamation-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/exclamation-statement.json"},{"slug":"pickbasic-flashbasic/execute-statement","title":"execute statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The execute statement temporarily pushes a level and performs any valid TCL expression, and then continues execution of the FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/execute-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/execute-statement.json"},{"slug":"pickbasic-flashbasic/execute-statement-unix","title":"execute statement (UNIX)","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The execute statement executes a UNIX command from within a FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/execute-statement-unix/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/execute-statement-unix.json"},{"slug":"pickbasic-flashbasic/exit-statement","title":"exit statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The exit statement forces an early exit from a loop that is under for...next or loop...repeat control.","url":"https://d3codex.com/pickbasic-flashbasic/exit-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/exit-statement.json"},{"slug":"pickbasic-flashbasic/exp-function","title":"exp() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The exp() function returns the exponential of a numeric expression, that is, base e, which is 2.718281828 rounded to precision to the power of the numeric expression.","url":"https://d3codex.com/pickbasic-flashbasic/exp-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/exp-function.json"},{"slug":"pickbasic-flashbasic/extract-function","title":"extract() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The extract() function retrieves a specific attribute, value, or subvalue from a dimensioned or dynamic array.","url":"https://d3codex.com/pickbasic-flashbasic/extract-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/extract-function.json"},{"slug":"pickbasic-flashbasic/field-function","title":"field() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The field() function returns a substring from a string expression, by specifying a delimiter and the desired occurrence.","url":"https://d3codex.com/pickbasic-flashbasic/field-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/field-function.json"},{"slug":"pickbasic-flashbasic/file-statement","title":"file statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The file statement is a compiler directive that allows the use of attribute definition items in the file’s dictionary while compiling a program.","url":"https://d3codex.com/pickbasic-flashbasic/file-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/file-statement.json"},{"slug":"pickbasic-flashbasic/file-variable","title":"File variable","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A file variable is the symbolic way to access a file after being previously opened in a BASIC program. File variables are assigned with the open statement.","url":"https://d3codex.com/pickbasic-flashbasic/file-variable/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/file-variable.json"},{"slug":"pickbasic-flashbasic/filelock-statement","title":"filelock statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The filelock statement sets an exclusive lock on an entire file.","url":"https://d3codex.com/pickbasic-flashbasic/filelock-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/filelock-statement.json"},{"slug":"pickbasic-flashbasic/fileunlock-statement","title":"fileunlock statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The fileunlock statement releases an exclusive lock set by the filelock statement on an entire file.","url":"https://d3codex.com/pickbasic-flashbasic/fileunlock-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/fileunlock-statement.json"},{"slug":"pickbasic-flashbasic/flash-interpreter","title":"Flash interpreter","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The d3flash utility is a DOS command that allows the launching of BASIC modules from a Windows command prompt. This launcher can be, in Windows, associated to the D3F extension and invoked automatically, thus making the D3F executable.","url":"https://d3codex.com/pickbasic-flashbasic/flash-interpreter/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flash-interpreter.json"},{"slug":"pickbasic-flashbasic/flashbasic-and-basic-differences","title":"FlashBASIC and BASIC differences","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"This topic describes the differences between FlashBASIC and BASIC.","url":"https://d3codex.com/pickbasic-flashbasic/flashbasic-and-basic-differences/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flashbasic-and-basic-differences.json"},{"slug":"pickbasic-flashbasic/flashbasic-automation-application-interfaces","title":"FlashBASIC automation application interfaces","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following FlashBASIC automation interfaces are presented.","url":"https://d3codex.com/pickbasic-flashbasic/flashbasic-automation-application-interfaces/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flashbasic-automation-application-interfaces.json"},{"slug":"pickbasic-flashbasic/flashbasic-c-functions","title":"FlashBASIC C functions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"This section includes the following FlashBASIC C function topics.","url":"https://d3codex.com/pickbasic-flashbasic/flashbasic-c-functions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flashbasic-c-functions.json"},{"slug":"pickbasic-flashbasic/flashbasic-c-functions-list","title":"FlashBASIC C functions list","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following FlashBASIC C Functions are available.","url":"https://d3codex.com/pickbasic-flashbasic/flashbasic-c-functions-list/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flashbasic-c-functions-list.json"},{"slug":"pickbasic-flashbasic/flashbasic-c-functions-overview","title":"FlashBASIC C functions overview","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"C functions can be called from a FlashBASIC program or subroutine using a syntax similar to that of normal C.","url":"https://d3codex.com/pickbasic-flashbasic/flashbasic-c-functions-overview/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flashbasic-c-functions-overview.json"},{"slug":"pickbasic-flashbasic/flashbasic-modules","title":"FlashBASIC modules","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"This section includes the following FlashBASIC modules topics.","url":"https://d3codex.com/pickbasic-flashbasic/flashbasic-modules/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flashbasic-modules.json"},{"slug":"pickbasic-flashbasic/flashbasic-triggers","title":"FlashBASIC triggers","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Triggers are FlashBASIC subroutines that accept one argument called when an operation is performed on a record or a table. Persistent data can be stored using named commons.","url":"https://d3codex.com/pickbasic-flashbasic/flashbasic-triggers/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/flashbasic-triggers.json"},{"slug":"pickbasic-flashbasic/fmt-function","title":"fmt() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The fmt() function is identical to performing a FlashBASIC or BASIC mask.","url":"https://d3codex.com/pickbasic-flashbasic/fmt-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/fmt-function.json"},{"slug":"pickbasic-flashbasic/fold-function","title":"fold() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The fold() function folds a string expression into a string of a given length.","url":"https://d3codex.com/pickbasic-flashbasic/fold-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/fold-function.json"},{"slug":"pickbasic-flashbasic/footing-statement","title":"footing statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The footing statement designates a text string composed of literals and special options to output at the bottom of each page.","url":"https://d3codex.com/pickbasic-flashbasic/footing-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/footing-statement.json"},{"slug":"pickbasic-flashbasic/for-next-statement","title":"for...next statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The for...next statement is an iterative, incremental loop statement used to repeat a sequence of statements for a specific number of occurrences.","url":"https://d3codex.com/pickbasic-flashbasic/for-next-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/for-next-statement.json"},{"slug":"pickbasic-flashbasic/format-strings","title":"Format strings","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Numeric and nonnumeric strings can be formatted using format strings, which consist of numeric masks and format masks. The numeric mask code controls justification, precision, scaling, and credit indication. The format mask code controls field length and fill characters.","url":"https://d3codex.com/pickbasic-flashbasic/format-strings/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/format-strings.json"},{"slug":"pickbasic-flashbasic/function-statement","title":"function statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"User-defined functions can be defined within a program. They can be used like sub-routines invoked with gosub or called externally like sub-routines invoked with call.","url":"https://d3codex.com/pickbasic-flashbasic/function-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/function-statement.json"},{"slug":"pickbasic-flashbasic/functions","title":"Functions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Functions are elements in BASIC language expressions, returning a single value in place, as a function of the arguments. A function can be used anywhere a variable or expression is used.","url":"https://d3codex.com/pickbasic-flashbasic/functions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/functions.json"},{"slug":"pickbasic-flashbasic/ge-relational-operator","title":"ge relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ge relational operator denotes a greater than or equal condition between two elements.","url":"https://d3codex.com/pickbasic-flashbasic/ge-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ge-relational-operator.json"},{"slug":"pickbasic-flashbasic/get-statement","title":"get statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The get statement gets raw characters from the specified port.","url":"https://d3codex.com/pickbasic-flashbasic/get-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/get-statement.json"},{"slug":"pickbasic-flashbasic/getx-statement","title":"getx statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The getx statement receives input from an attached line in ASCII hexadecimal format. The statement returns an exploded ASCII hexadecimal string that allows binary data to contain a decimal 255 (x’ff’)","url":"https://d3codex.com/pickbasic-flashbasic/getx-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/getx-statement.json"},{"slug":"pickbasic-flashbasic/global-common","title":"Global Common","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Global common is a named BASIC variable space used to store variables and arrays in the identified area that is only initialized at logon.","url":"https://d3codex.com/pickbasic-flashbasic/global-common/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/global-common.json"},{"slug":"pickbasic-flashbasic/gosub-statement","title":"gosub statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The gosub statement transfers control to a local subroutine identified by a statement label within the program. Control returns to the next statement after the gosub statement when the return statement is encountered.","url":"https://d3codex.com/pickbasic-flashbasic/gosub-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/gosub-statement.json"},{"slug":"pickbasic-flashbasic/goto-statement","title":"goto statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The goto statement transfers control to the location in the FlashBASIC or BASIC program that begins with the given statement label.","url":"https://d3codex.com/pickbasic-flashbasic/goto-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/goto-statement.json"},{"slug":"pickbasic-flashbasic/greater-than-equals-relational-operator","title":">= relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The >= relational operator is the greater than or equal to operator.","url":"https://d3codex.com/pickbasic-flashbasic/greater-than-equals-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/greater-than-equals-relational-operator.json"},{"slug":"pickbasic-flashbasic/greater-than-les-than-relational-operator","title":">< relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The >< relational operator is the not equal operator.","url":"https://d3codex.com/pickbasic-flashbasic/greater-than-les-than-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/greater-than-les-than-relational-operator.json"},{"slug":"pickbasic-flashbasic/greater-than-relational-operator","title":"> relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The >relational operator is the greater than operator.","url":"https://d3codex.com/pickbasic-flashbasic/greater-than-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/greater-than-relational-operator.json"},{"slug":"pickbasic-flashbasic/gt-relational-operator","title":"gt relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The gt relational operator denotes a greater than condition between two elements.","url":"https://d3codex.com/pickbasic-flashbasic/gt-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/gt-relational-operator.json"},{"slug":"pickbasic-flashbasic/heading-statement","title":"heading statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The heading statement designates a text string composed of literals and special options to output at the top of each page.","url":"https://d3codex.com/pickbasic-flashbasic/heading-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/heading-statement.json"},{"slug":"pickbasic-flashbasic/iconv-function","title":"iconv() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The iconv() function converts a value from its external format to its internal equivalent, according to the processing code being applied.","url":"https://d3codex.com/pickbasic-flashbasic/iconv-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/iconv-function.json"},{"slug":"pickbasic-flashbasic/id-expression","title":"ID expression","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"An ID expression is a string expression that evaluates to an item-ID, for use in all types of read and write statements.","url":"https://d3codex.com/pickbasic-flashbasic/id-expression/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/id-expression.json"},{"slug":"pickbasic-flashbasic/if-statement","title":"if statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The if statement tests the result of a logical expression. Depending on whether the expression evaluates to either true or false, the statements following the then or else clauses, respectively, are executed.","url":"https://d3codex.com/pickbasic-flashbasic/if-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/if-statement.json"},{"slug":"pickbasic-flashbasic/ifdef-directive","title":"$IFDEF directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $IFDEF directive tests for the definition of an identifier in the compiler symbol table.","url":"https://d3codex.com/pickbasic-flashbasic/ifdef-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ifdef-directive.json"},{"slug":"pickbasic-flashbasic/ifndef-directive","title":"$IFNDEF directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $IFNDEF directive tests for the absence of a definition for an identifier in the compiler symbol table.","url":"https://d3codex.com/pickbasic-flashbasic/ifndef-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ifndef-directive.json"},{"slug":"pickbasic-flashbasic/ifr-statement","title":"ifr statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ifr statement tests the result of a logical expression.","url":"https://d3codex.com/pickbasic-flashbasic/ifr-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ifr-statement.json"},{"slug":"pickbasic-flashbasic/in-statement","title":"in statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The in statement accepts a single raw character of input from the keyboard, without displaying a prompt character or requiring pressing ENTER following the input.","url":"https://d3codex.com/pickbasic-flashbasic/in-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/in-statement.json"},{"slug":"pickbasic-flashbasic/index-function","title":"index() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The index() function searches through a given str.exp for the occurrence of the character or substring specified by substr.exp and if found, returns the numeric position where the nth occurrence of the substring begins. Null strings are skipped.","url":"https://d3codex.com/pickbasic-flashbasic/index-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/index-function.json"},{"slug":"pickbasic-flashbasic/inmat-function","title":"inmat() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inmat() function returns information about arrays.","url":"https://d3codex.com/pickbasic-flashbasic/inmat-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inmat-function.json"},{"slug":"pickbasic-flashbasic/input-statement","title":"input statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The input statement temporarily suspends execution of the program until a response is provided from the keyboard, and then assigns that response to a specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/input-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/input-statement.json"},{"slug":"pickbasic-flashbasic/inputclear-statement","title":"inputclear statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputclear statement clears the keyboard type-ahead buffer.","url":"https://d3codex.com/pickbasic-flashbasic/inputclear-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputclear-statement.json"},{"slug":"pickbasic-flashbasic/inputctrl-statement","title":"inputctrl statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputctrl statement is used to enable or suppress control characters in BASIC input statements.","url":"https://d3codex.com/pickbasic-flashbasic/inputctrl-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputctrl-statement.json"},{"slug":"pickbasic-flashbasic/inputerr-statement","title":"inputerr statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputerr statement displays a message on the status (bottom) line of the terminal. it meant to be used with the input@ statement.","url":"https://d3codex.com/pickbasic-flashbasic/inputerr-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputerr-statement.json"},{"slug":"pickbasic-flashbasic/inputerr-statement-windows","title":"inputerr statement (Windows)","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"When run from a trigger, from the D3 File Manager, or from a Visual Basic rule module, the inputerr statement displays a dialog box (allowing the user to specify the title, text, and buttons), then waits for input. Upon return, the system(0) function returns a numeric code indicating the user choice.","url":"https://d3codex.com/pickbasic-flashbasic/inputerr-statement-windows/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputerr-statement-windows.json"},{"slug":"pickbasic-flashbasic/inputif-statement","title":"inputif statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputif statement captures input from the type-ahead buffer and assigns the input to a variable.","url":"https://d3codex.com/pickbasic-flashbasic/inputif-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputif-statement.json"},{"slug":"pickbasic-flashbasic/inputnull-statement","title":"inputnull statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputnull statement is used with the input @ statement to define the character used to indicate a null input on subsequent input statements.","url":"https://d3codex.com/pickbasic-flashbasic/inputnull-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputnull-statement.json"},{"slug":"pickbasic-flashbasic/inputparity-statement","title":"inputparity statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputparity statement enables or disables the extended character set (xcs) for the current process.","url":"https://d3codex.com/pickbasic-flashbasic/inputparity-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputparity-statement.json"},{"slug":"pickbasic-flashbasic/inputtrap-gosub-statement","title":"inputtrap...gosub statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputtrap...gosub statement, using the str.exp, sets up an automatic computed gosub based on the next input @ statement data. The position of the character in the string expression corresponds to the position of the statement label in the list. This acts as a trap that causes a gosub on all subsequent input @ statements.","url":"https://d3codex.com/pickbasic-flashbasic/inputtrap-gosub-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputtrap-gosub-statement.json"},{"slug":"pickbasic-flashbasic/inputtrap-goto-statement","title":"inputtrap...goto statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputtrap...goto statement, using the str.exp, sets up an automatic computed goto based on the next input @ statement’s data. The position of each character in the string expression corresponds to the position of the statement label in the list. This acts as a trap that causes a goto on all subsequent input @ statements and branches to a label in the current program.","url":"https://d3codex.com/pickbasic-flashbasic/inputtrap-goto-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputtrap-goto-statement.json"},{"slug":"pickbasic-flashbasic/inputtrap-off-statement","title":"inputtrap off statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The inputtrap off statement cancels the previous inputtrap statement.","url":"https://d3codex.com/pickbasic-flashbasic/inputtrap-off-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inputtrap-off-statement.json"},{"slug":"pickbasic-flashbasic/ins-statement","title":"ins statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ins statement is an alternative to the insert() function for inserting a string expression into a dynamic array.","url":"https://d3codex.com/pickbasic-flashbasic/ins-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ins-statement.json"},{"slug":"pickbasic-flashbasic/insert-function","title":"insert() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The insert() function inserts the element referenced by str.exp into a specific attribute, value, or subvalue location in dyn.array.exp.","url":"https://d3codex.com/pickbasic-flashbasic/insert-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/insert-function.json"},{"slug":"pickbasic-flashbasic/inserting-a-trigger","title":"Inserting a trigger","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A trigger is inserted by adding a correlative in the D-pointer of the table.","url":"https://d3codex.com/pickbasic-flashbasic/inserting-a-trigger/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/inserting-a-trigger.json"},{"slug":"pickbasic-flashbasic/int-function","title":"int() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The int() function returns the numeric integer equivalent from a given expression.","url":"https://d3codex.com/pickbasic-flashbasic/int-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/int-function.json"},{"slug":"pickbasic-flashbasic/key-statement","title":"key statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The key statement locates an item using a B-tree index key and returns the item in a variable. This provides the ability to sequentially search the items in the file based on the index.","url":"https://d3codex.com/pickbasic-flashbasic/key-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/key-statement.json"},{"slug":"pickbasic-flashbasic/le-relational-operator","title":"le relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The le relational operator represents the less than or equal to (<=) condition.","url":"https://d3codex.com/pickbasic-flashbasic/le-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/le-relational-operator.json"},{"slug":"pickbasic-flashbasic/len-function","title":"len() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The len() function returns the length of a string expression.","url":"https://d3codex.com/pickbasic-flashbasic/len-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/len-function.json"},{"slug":"pickbasic-flashbasic/less-than-equals-relational-operator","title":"<= relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The <= relational operator is the less than or equal to operator.","url":"https://d3codex.com/pickbasic-flashbasic/less-than-equals-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/less-than-equals-relational-operator.json"},{"slug":"pickbasic-flashbasic/less-than-greater-than-relational-operator","title":"<> relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The <> relational operator represents a not equal to operator.","url":"https://d3codex.com/pickbasic-flashbasic/less-than-greater-than-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/less-than-greater-than-relational-operator.json"},{"slug":"pickbasic-flashbasic/less-than-greater-than-reserved-characters","title":"<> reserved characters","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The <> reserved characters surround subscripts within dynamic arrays.","url":"https://d3codex.com/pickbasic-flashbasic/less-than-greater-than-reserved-characters/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/less-than-greater-than-reserved-characters.json"},{"slug":"pickbasic-flashbasic/let-statement","title":"let statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The let statement assigns the value of an expression to a variable.","url":"https://d3codex.com/pickbasic-flashbasic/let-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/let-statement.json"},{"slug":"pickbasic-flashbasic/ln-function","title":"ln() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ln() function returns the natural logarithm (base e, which is 2.718281828 rounded to precision) of a given numeric expression.","url":"https://d3codex.com/pickbasic-flashbasic/ln-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ln-function.json"},{"slug":"pickbasic-flashbasic/locate-function","title":"locate() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"See the locate statement documentation.","url":"https://d3codex.com/pickbasic-flashbasic/locate-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/locate-function.json"},{"slug":"pickbasic-flashbasic/locate-statement","title":"locate statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The locate statement searches for the location of a specific string expression and returns the location in position.var.","url":"https://d3codex.com/pickbasic-flashbasic/locate-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/locate-statement.json"},{"slug":"pickbasic-flashbasic/lock-statement","title":"lock statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The lock statement sets one of 992 execution locks. This prevents re-entry to the program, allowing only one process to run the program at any given time.","url":"https://d3codex.com/pickbasic-flashbasic/lock-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/lock-statement.json"},{"slug":"pickbasic-flashbasic/locked-clause","title":"locked clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The locked clause is used when the requested item is locked and waiting is not desired.","url":"https://d3codex.com/pickbasic-flashbasic/locked-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/locked-clause.json"},{"slug":"pickbasic-flashbasic/logical-expressions","title":"Logical expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Logical expressions (also called Boolean expressions) are the result of applying logical (Boolean) operators to relational or arithmetic expressions. The result of an operation has two possible states: true or false. Logical expressions are considered false when equal to 0, and are considered true when nonzero.","url":"https://d3codex.com/pickbasic-flashbasic/logical-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/logical-expressions.json"},{"slug":"pickbasic-flashbasic/loop-statement","title":"loop statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The loop statement repetitively executes (loops) until an ending condition is met. The first set of statements, if present, is executed at least once.","url":"https://d3codex.com/pickbasic-flashbasic/loop-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/loop-statement.json"},{"slug":"pickbasic-flashbasic/lt-relational-operator","title":"lt relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The lt relational operator is used in conditional expressions as an alternate form of the less than (<) condition.","url":"https://d3codex.com/pickbasic-flashbasic/lt-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/lt-relational-operator.json"},{"slug":"pickbasic-flashbasic/masking","title":"Masking","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Masking is the process of formatting expressions using numeric masks and format masks.","url":"https://d3codex.com/pickbasic-flashbasic/masking/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/masking.json"},{"slug":"pickbasic-flashbasic/mat-statement","title":"mat statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The mat statement assigns data to each element of a dimensioned array variable to a specific value in one operation.","url":"https://d3codex.com/pickbasic-flashbasic/mat-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/mat-statement.json"},{"slug":"pickbasic-flashbasic/matbuild-statement","title":"matbuild statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The matbuild statement converts a dimensioned array into a dynamic array.","url":"https://d3codex.com/pickbasic-flashbasic/matbuild-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/matbuild-statement.json"},{"slug":"pickbasic-flashbasic/match-relational-operator","title":"match relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The match relational operator tests a string and determines if it matches a predefined pattern of alphabetical, numeric, wildcard, or literal characters.","url":"https://d3codex.com/pickbasic-flashbasic/match-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/match-relational-operator.json"},{"slug":"pickbasic-flashbasic/matparse-statement","title":"matparse statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The matparse statement converts a dynamic array into a dimensioned array.","url":"https://d3codex.com/pickbasic-flashbasic/matparse-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/matparse-statement.json"},{"slug":"pickbasic-flashbasic/matread-statement","title":"matread statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The matread statement reads the specified item from the optionally specified file.var, or if not specified, the default file.var, and stores one attribute per element in the dimensioned array.","url":"https://d3codex.com/pickbasic-flashbasic/matread-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/matread-statement.json"},{"slug":"pickbasic-flashbasic/matreadu-statement","title":"matreadu statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The matreadu form of the matread statement tests if an item is already locked and locks the item if it is not. The item lock set by matreadu prevents the item from being read using the matreadu statement or updated by other processes while the lock is set.","url":"https://d3codex.com/pickbasic-flashbasic/matreadu-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/matreadu-statement.json"},{"slug":"pickbasic-flashbasic/matwrite-statement","title":"matwrite statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The matwrite statement writes an item into the specified file.var.","url":"https://d3codex.com/pickbasic-flashbasic/matwrite-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/matwrite-statement.json"},{"slug":"pickbasic-flashbasic/matwriteu-statement","title":"matwriteu statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The matwriteu statement is identical to the matwrite statement, except the item remains locked. The matwriteu form keeps the item locked if it was previously locked by a readu, readvu, or matwriteu statement within the same program.","url":"https://d3codex.com/pickbasic-flashbasic/matwriteu-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/matwriteu-statement.json"},{"slug":"pickbasic-flashbasic/maximum-function","title":"maximum() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The maximum() function returns the maximum of a list of numbers delimited by attribute, value, or subvalue marks. If different orders of marks are present, the maximum() function returns the maximum of all fields, regardless of delimiter.","url":"https://d3codex.com/pickbasic-flashbasic/maximum-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/maximum-function.json"},{"slug":"pickbasic-flashbasic/minimum-function","title":"minimum() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The minimum() function returns the minimum of a list of numbers delimited by attribute, value, or subvalue marks. If different orders of marks are present, the minimum() function returns the minimum of all fields, regardless of delimiter.","url":"https://d3codex.com/pickbasic-flashbasic/minimum-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/minimum-function.json"},{"slug":"pickbasic-flashbasic/minus-arithmetic-operator","title":"- arithmetic operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The - arithmetic operator designates a subtraction operation, or to indicate a negative numeric value.","url":"https://d3codex.com/pickbasic-flashbasic/minus-arithmetic-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/minus-arithmetic-operator.json"},{"slug":"pickbasic-flashbasic/minus-equals-assignment-operator","title":"-= assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The -= assignment operator decrements a variable by a numeric expression.","url":"https://d3codex.com/pickbasic-flashbasic/minus-equals-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/minus-equals-assignment-operator.json"},{"slug":"pickbasic-flashbasic/mod-function","title":"mod() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The mod() function returns the remainder portion of the result of dividing one number by another.","url":"https://d3codex.com/pickbasic-flashbasic/mod-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/mod-function.json"},{"slug":"pickbasic-flashbasic/named-common","title":"Named common","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A named common is a global, common, BASIC variable space used to store variables and arrays in the area identified by ID. Named common space is initialized only at logon and released at logoff.","url":"https://d3codex.com/pickbasic-flashbasic/named-common/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/named-common.json"},{"slug":"pickbasic-flashbasic/named-common-in-triggers","title":"Named common in triggers","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Triggers can use named commons to create persistent data across the various operations.","url":"https://d3codex.com/pickbasic-flashbasic/named-common-in-triggers/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/named-common-in-triggers.json"},{"slug":"pickbasic-flashbasic/ne-relational-operator","title":"ne relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ne relational operator represents a not equal to condition within relational expressions.","url":"https://d3codex.com/pickbasic-flashbasic/ne-relational-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ne-relational-operator.json"},{"slug":"pickbasic-flashbasic/next-statement","title":"next statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The next statement occurs at the end of a for...next construct and causes the iteration counter to increment and branches to the corresponding for statement to decide whether to terminate.","url":"https://d3codex.com/pickbasic-flashbasic/next-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/next-statement.json"},{"slug":"pickbasic-flashbasic/nonfatal-error-condition","title":"Nonfatal error condition","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A nonfatal error condition is a type of error that occurs when a BASIC program encounters a condition that is resolved by the BASIC run-time package, although not to the specific need of the program line of code.","url":"https://d3codex.com/pickbasic-flashbasic/nonfatal-error-condition/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/nonfatal-error-condition.json"},{"slug":"pickbasic-flashbasic/not-function","title":"not() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The not() function returns the logical inverse of the normal outcome of true and false generated by a logical expression.","url":"https://d3codex.com/pickbasic-flashbasic/not-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/not-function.json"},{"slug":"pickbasic-flashbasic/nuclear-tokens","title":"Nuclear tokens","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Any function or expression can itself be an argument of another function or expression. The compiler evaluates expressions starting with the innermost set of parentheses.","url":"https://d3codex.com/pickbasic-flashbasic/nuclear-tokens/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/nuclear-tokens.json"},{"slug":"pickbasic-flashbasic/null-evaluation","title":"Null evaluation","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Represents an empty string or decimal zero value depending on the context, string, or arithmetic operation.","url":"https://d3codex.com/pickbasic-flashbasic/null-evaluation/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/null-evaluation.json"},{"slug":"pickbasic-flashbasic/null-statement","title":"null statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The null statement performs no operation, other than to provide an instruction where one is required. This is usually used for program readability.","url":"https://d3codex.com/pickbasic-flashbasic/null-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/null-statement.json"},{"slug":"pickbasic-flashbasic/num-function","title":"num() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The num() function evaluates an expression and returns 1 (true) if it is a decimal numeric. Otherwise, it returns 0, if the expression contains any nonnumeric characters.","url":"https://d3codex.com/pickbasic-flashbasic/num-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/num-function.json"},{"slug":"pickbasic-flashbasic/numeric-expressions","title":"Numeric expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A numeric expression is any expression that evaluates to a number.","url":"https://d3codex.com/pickbasic-flashbasic/numeric-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/numeric-expressions.json"},{"slug":"pickbasic-flashbasic/nxtkey-statement","title":"nxtkey statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The nxtkey statement scans forward through a key file along a key path.","url":"https://d3codex.com/pickbasic-flashbasic/nxtkey-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/nxtkey-statement.json"},{"slug":"pickbasic-flashbasic/occurs-function","title":"occurs() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The occurs() function searches a string for attributes or values that occur consecutively.","url":"https://d3codex.com/pickbasic-flashbasic/occurs-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/occurs-function.json"},{"slug":"pickbasic-flashbasic/oconv-function","title":"oconv() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The oconv() function converts a value from its internal format to its external equivalent, according to the processing code being applied.","url":"https://d3codex.com/pickbasic-flashbasic/oconv-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/oconv-function.json"},{"slug":"pickbasic-flashbasic/on-error-clause","title":"on error clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The on error clause, which consists of the text on error followed by a statement list, is taken if the update fails due to a lost network connection or a callx that executes an inputerr statement.","url":"https://d3codex.com/pickbasic-flashbasic/on-error-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/on-error-clause.json"},{"slug":"pickbasic-flashbasic/on-gosub-statement","title":"on...gosub statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The on... gosub statement transfers control to a local subroutine designated by a specific statement label according to the positional value returned by the expression. The syntax can also be specified as on...go sub...(allowing a space between go and sub).","url":"https://d3codex.com/pickbasic-flashbasic/on-gosub-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/on-gosub-statement.json"},{"slug":"pickbasic-flashbasic/on-goto-statement","title":"on...goto statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The on...goto statement transfers control to the line within the FlashBASIC or BASIC program that begins with the specified statement label, according to the positional value of the expression referenced by exp. The syntax can also be specified as on...go to...(allowing a space between go and to).","url":"https://d3codex.com/pickbasic-flashbasic/on-goto-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/on-goto-statement.json"},{"slug":"pickbasic-flashbasic/onerr-clause","title":"onerr clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The onerr clause identifies the statements to execute when an error occurs during statements that perform operations on peripheral storage devices.","url":"https://d3codex.com/pickbasic-flashbasic/onerr-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/onerr-clause.json"},{"slug":"pickbasic-flashbasic/open-statement","title":"open statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The open statement opens a specified file name and associates the file with the optional file.var.","url":"https://d3codex.com/pickbasic-flashbasic/open-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/open-statement.json"},{"slug":"pickbasic-flashbasic/operators","title":"Operators","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Operators are reserved characters (and combinations of adjacent characters) and can be referenced individually by their respective symbol.","url":"https://d3codex.com/pickbasic-flashbasic/operators/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/operators.json"},{"slug":"pickbasic-flashbasic/or-logical-operator","title":"or logical operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The or logical operator indicates that only one of the components of a logical expression need be true for the expression to evaluate as true.","url":"https://d3codex.com/pickbasic-flashbasic/or-logical-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/or-logical-operator.json"},{"slug":"pickbasic-flashbasic/os-interoperability-commands","title":"O/S interoperability commands and functions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Execute Windows programs and/or access files using the O/S interoperability commands and functions.","url":"https://d3codex.com/pickbasic-flashbasic/os-interoperability-commands/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/os-interoperability-commands.json"},{"slug":"pickbasic-flashbasic/out-statement","title":"out statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The out statement outputs a single ASCII character derived from a numeric expression in the range of 0 through 255, which indicates its corresponding position in the ASCII table.","url":"https://d3codex.com/pickbasic-flashbasic/out-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/out-statement.json"},{"slug":"pickbasic-flashbasic/page-statement","title":"page statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The page statement terminates the current page of output, prints the optional footing, positions to the top of the form, and prints the optional heading.","url":"https://d3codex.com/pickbasic-flashbasic/page-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/page-statement.json"},{"slug":"pickbasic-flashbasic/parenthesis-reserved-characters","title":"() reserved characters","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The () (left and right parentheses) reserved characters surround arguments within functions, encloses subscript references within dimensioned arrays, and override the normal order of precedence evaluation.","url":"https://d3codex.com/pickbasic-flashbasic/parenthesis-reserved-characters/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/parenthesis-reserved-characters.json"},{"slug":"pickbasic-flashbasic/passing-d3-visual-basic-objects","title":"Passing D3 Visual Basic objects","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The following D3 Visual Basic object handles (using the brHandle method available to each D3 Visual Basic object) can be passed to a FlashBASIC subroutine:","url":"https://d3codex.com/pickbasic-flashbasic/passing-d3-visual-basic-objects/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/passing-d3-visual-basic-objects.json"},{"slug":"pickbasic-flashbasic/passing-visual-basic-arguments","title":"Passing Visual Basic arguments","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"As detailed in the D3 Visual Basic documentation, only VARIANT variables can be passed to the FlashBASIC subroutine, and any number of them may be passed. Arguments are passed by references, which means they can be modified on return. There are some exceptions listed in the table below.","url":"https://d3codex.com/pickbasic-flashbasic/passing-visual-basic-arguments/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/passing-visual-basic-arguments.json"},{"slug":"pickbasic-flashbasic/percent-accept-function","title":"%accept() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %accept() function extracts the first connection on the queue of pending connections, creates a new socket, and allocates a new file descriptor.","url":"https://d3codex.com/pickbasic-flashbasic/percent-accept-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-accept-function.json"},{"slug":"pickbasic-flashbasic/percent-accept-ssl-function","title":"%accept_ssl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %accept_ssl() function first calls the %accept() function to extract the first connection on the queue of pending connections, and then creates a new socket.","url":"https://d3codex.com/pickbasic-flashbasic/percent-accept-ssl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-accept-ssl-function.json"},{"slug":"pickbasic-flashbasic/percent-accept-starttls-function","title":"%accept_starttls() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %accept_starttls function provides the ability to elevate an unsecured connection to a secured connection.","url":"https://d3codex.com/pickbasic-flashbasic/percent-accept-starttls-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-accept-starttls-function.json"},{"slug":"pickbasic-flashbasic/percent-alarm-function","title":"%alarm() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %alarm() function instructs the alarm clock of the calling process to send the signal SIGALRM to the calling process.","url":"https://d3codex.com/pickbasic-flashbasic/percent-alarm-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-alarm-function.json"},{"slug":"pickbasic-flashbasic/percent-bind-function","title":"%bind() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %bind() function binds a socket to a named resource. In case of a network, the resource would be an access point into the system.","url":"https://d3codex.com/pickbasic-flashbasic/percent-bind-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-bind-function.json"},{"slug":"pickbasic-flashbasic/percent-calloc-function","title":"%calloc() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Allocates and frees dynamic memory.","url":"https://d3codex.com/pickbasic-flashbasic/percent-calloc-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-calloc-function.json"},{"slug":"pickbasic-flashbasic/percent-chdir-function","title":"%chdir() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %chdir() function changes the current directory to the one specified in str.","url":"https://d3codex.com/pickbasic-flashbasic/percent-chdir-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-chdir-function.json"},{"slug":"pickbasic-flashbasic/percent-chmod-function","title":"%chmod() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %chmod() function changes the mode of the file str to the value specified in mode.","url":"https://d3codex.com/pickbasic-flashbasic/percent-chmod-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-chmod-function.json"},{"slug":"pickbasic-flashbasic/percent-chown-function","title":"%chown() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %chown() function changes the owner-ID and group-ID of the file str to the values specified in owner and group respectively.","url":"https://d3codex.com/pickbasic-flashbasic/percent-chown-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-chown-function.json"},{"slug":"pickbasic-flashbasic/percent-close-function","title":"%close() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %close() function closes the UNIX file specified by file.descriptor returned by a previous call to %open(), %creat(), %dup(), %socket(), or %accept().","url":"https://d3codex.com/pickbasic-flashbasic/percent-close-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-close-function.json"},{"slug":"pickbasic-flashbasic/percent-close-ssl-function","title":"%close_ssl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %close_ssl function closes the socket specified by the fd file descriptor, as well as the secure connection specified by the ssl_fd descriptor. The fd file descriptor is returned by a previous call to %socket whereas the ssl_fd descriptor is returned buy a previous call to %accept_ssl() or %connect_ssl.","url":"https://d3codex.com/pickbasic-flashbasic/percent-close-ssl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-close-ssl-function.json"},{"slug":"pickbasic-flashbasic/percent-closeall-function","title":"%closeall() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %closeall() function closes all opened file-descriptors, including sockets.","url":"https://d3codex.com/pickbasic-flashbasic/percent-closeall-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-closeall-function.json"},{"slug":"pickbasic-flashbasic/percent-closesocket-function","title":"%closesocket() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %closesocket() function closes an existing socket.","url":"https://d3codex.com/pickbasic-flashbasic/percent-closesocket-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-closesocket-function.json"},{"slug":"pickbasic-flashbasic/percent-connect-function","title":"%connect() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %connect() function requests a connection between two sockets.","url":"https://d3codex.com/pickbasic-flashbasic/percent-connect-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-connect-function.json"},{"slug":"pickbasic-flashbasic/percent-connect-ssl-function","title":"%connect_ssl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %connect_ssl() function requests a secure connection between two sockets.","url":"https://d3codex.com/pickbasic-flashbasic/percent-connect-ssl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-connect-ssl-function.json"},{"slug":"pickbasic-flashbasic/percent-connect-starttls-function","title":"%connect_starttls() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %connect_starttls function provides the ability to elevate an unsecured connection to a secured connection.","url":"https://d3codex.com/pickbasic-flashbasic/percent-connect-starttls-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-connect-starttls-function.json"},{"slug":"pickbasic-flashbasic/percent-creat-function","title":"%creat() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %creat() function creates a new host OS file or prepares to rewrite an existing host OS file designated by str for write only.","url":"https://d3codex.com/pickbasic-flashbasic/percent-creat-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-creat-function.json"},{"slug":"pickbasic-flashbasic/percent-decrypt-function","title":"%decrypt() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %decrypt() function decrypts a string. The appropriate OpenSSL libraries must be present to use this function. See your platform-specific System Administration Guide for details.","url":"https://d3codex.com/pickbasic-flashbasic/percent-decrypt-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-decrypt-function.json"},{"slug":"pickbasic-flashbasic/percent-dup-function","title":"%dup() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %dup() function returns a new file descriptor associated to the same file as the one associated with file.descriptor.","url":"https://d3codex.com/pickbasic-flashbasic/percent-dup-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-dup-function.json"},{"slug":"pickbasic-flashbasic/percent-encrypt-function","title":"%encrypt() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %encrypt() function encrypts a string. The appropriate OpenSSL libraries must be present to use this function. See your platform-specific System Administration Guide for details.","url":"https://d3codex.com/pickbasic-flashbasic/percent-encrypt-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-encrypt-function.json"},{"slug":"pickbasic-flashbasic/percent-endlistilocks-function","title":"%endlistilocks() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %endlistilocks() function is used to release the handle allocated by the %startlistilocks() function.","url":"https://d3codex.com/pickbasic-flashbasic/percent-endlistilocks-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-endlistilocks-function.json"},{"slug":"pickbasic-flashbasic/percent-fclose-function","title":"%fclose() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fclose() function closes the stream specified by stream returned by a previous call to %fopen().","url":"https://d3codex.com/pickbasic-flashbasic/percent-fclose-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fclose-function.json"},{"slug":"pickbasic-flashbasic/percent-fdopen-function","title":"%fdopen() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fdopen() function associates a stream with the file.descriptor obtained from an %open(), %dup(), or %creat().","url":"https://d3codex.com/pickbasic-flashbasic/percent-fdopen-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fdopen-function.json"},{"slug":"pickbasic-flashbasic/percent-fgetc-function","title":"%fgetc() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fgetc() function returns the next character from the named input stream.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fgetc-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fgetc-function.json"},{"slug":"pickbasic-flashbasic/percent-fgets-function","title":"%fgets() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fgets() function reads characters from the named input stream into var until n-1 characters are read or a new line character is read and transferred to the string.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fgets-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fgets-function.json"},{"slug":"pickbasic-flashbasic/percent-filecheck-function","title":"%filecheck() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %filecheck() function can be run from the TCL to call the system fsck (file system check) command.","url":"https://d3codex.com/pickbasic-flashbasic/percent-filecheck-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-filecheck-function.json"},{"slug":"pickbasic-flashbasic/percent-fopen-function","title":"%fopen() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fopen() function opens the host OS file designated by str and associates a stream with it.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fopen-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fopen-function.json"},{"slug":"pickbasic-flashbasic/percent-fprintf-function","title":"%fprintf() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fprintf() function writes formatted output on stream under control of format.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fprintf-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fprintf-function.json"},{"slug":"pickbasic-flashbasic/percent-fputc-function","title":"%fputc() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fputc() function writes the character specified by character on the named output stream.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fputc-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fputc-function.json"},{"slug":"pickbasic-flashbasic/percent-fputs-function","title":"%fputs() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fputs() function writes the string designated by str on the named output stream.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fputs-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fputs-function.json"},{"slug":"pickbasic-flashbasic/percent-fread-function","title":"%fread() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Binary stream input/output.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fread-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fread-function.json"},{"slug":"pickbasic-flashbasic/percent-free-function","title":"%free() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %free() function frees a block of memory allocated by a call to %malloc().","url":"https://d3codex.com/pickbasic-flashbasic/percent-free-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-free-function.json"},{"slug":"pickbasic-flashbasic/percent-freopen-function","title":"%freopen() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %freopen() function substitutes the named file specified by str in place of the opened stream stream1.","url":"https://d3codex.com/pickbasic-flashbasic/percent-freopen-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-freopen-function.json"},{"slug":"pickbasic-flashbasic/percent-fsize-function","title":"%fsize() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %fsize() function returns the size in bytes of the file associated to the opened file.descriptor returned by a previous call to %open() or %creat().","url":"https://d3codex.com/pickbasic-flashbasic/percent-fsize-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fsize-function.json"},{"slug":"pickbasic-flashbasic/percent-fwrite-function","title":"%fwrite() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Binary stream input/output.","url":"https://d3codex.com/pickbasic-flashbasic/percent-fwrite-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-fwrite-function.json"},{"slug":"pickbasic-flashbasic/percent-getaddrinfo-function","title":"%getaddrinfo() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Front end to the socket %getaddrinfo() function.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getaddrinfo-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getaddrinfo-function.json"},{"slug":"pickbasic-flashbasic/percent-getenv-function","title":"%getenv() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %getenv() function searches the environment for a string of the form name=value and returns a pointer to value in the current environment if such a string is present, otherwise, a null is returned.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getenv-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getenv-function.json"},{"slug":"pickbasic-flashbasic/percent-gethostid-function","title":"%gethostid() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %gethostid() function allows a FlashBASIC application to retrieve the unique 32-bit identifier for the current host. The ID is returned as a decimal number.","url":"https://d3codex.com/pickbasic-flashbasic/percent-gethostid-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-gethostid-function.json"},{"slug":"pickbasic-flashbasic/percent-gethostname-function","title":"%gethostname() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %gethostname() function retrieves the standard host name for the local computer.","url":"https://d3codex.com/pickbasic-flashbasic/percent-gethostname-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-gethostname-function.json"},{"slug":"pickbasic-flashbasic/percent-getnamedhost-function","title":"%getnamedhost() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Front end to the socket %gethostbyname() function.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getnamedhost-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getnamedhost-function.json"},{"slug":"pickbasic-flashbasic/percent-getperfcount-function","title":"%getperfcount() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %getperfcount() function returns the D3 performance counters.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getperfcount-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getperfcount-function.json"},{"slug":"pickbasic-flashbasic/percent-getpgrp-function","title":"%getpgrp() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %getpgrp() function returns the UNIX process group ID of the calling process.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getpgrp-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getpgrp-function.json"},{"slug":"pickbasic-flashbasic/percent-getpid-function","title":"%getpid() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %getpid() function returns the Process-ID (PID) of the calling process.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getpid-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getpid-function.json"},{"slug":"pickbasic-flashbasic/percent-getppid-function","title":"%getppid() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %getppid() function returns the UNIX parent Process-ID of the calling process.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getppid-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getppid-function.json"},{"slug":"pickbasic-flashbasic/percent-getsockopt-function","title":"%getsockopt() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %getsockopt() function retrieves a socket option.","url":"https://d3codex.com/pickbasic-flashbasic/percent-getsockopt-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-getsockopt-function.json"},{"slug":"pickbasic-flashbasic/percent-inet-addr-function","title":"%inet_addr() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %inet_addr() function converts a string containing an IPv4 dotted-decimal address into a proper address for the IN_ADDR structure.","url":"https://d3codex.com/pickbasic-flashbasic/percent-inet-addr-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-inet-addr-function.json"},{"slug":"pickbasic-flashbasic/percent-ioctl-function","title":"%ioctl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %ioctl() function is a general purpose control function that passes the arguments request and arg to the device designated by file.descriptor.","url":"https://d3codex.com/pickbasic-flashbasic/percent-ioctl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-ioctl-function.json"},{"slug":"pickbasic-flashbasic/percent-ioctlsocket-function","title":"%ioctlsocket() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %ioctlsocket() function controls the I/O mode of a socket.","url":"https://d3codex.com/pickbasic-flashbasic/percent-ioctlsocket-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-ioctlsocket-function.json"},{"slug":"pickbasic-flashbasic/percent-kill-function","title":"%kill() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %kill() function sends the signal specified in signal to the process pid.","url":"https://d3codex.com/pickbasic-flashbasic/percent-kill-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-kill-function.json"},{"slug":"pickbasic-flashbasic/percent-listen-function","title":"%listen() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %listen() function marks the specified socket as accepting incoming connections and limits the number of outstanding connections in the system queue.","url":"https://d3codex.com/pickbasic-flashbasic/percent-listen-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-listen-function.json"},{"slug":"pickbasic-flashbasic/percent-listitemlocksfilter-function","title":"%listitemlocksfilter() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The listitemlocksfilter() function is used to get a list of the FSI item locks in a dynamic array format.","url":"https://d3codex.com/pickbasic-flashbasic/percent-listitemlocksfilter-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-listitemlocksfilter-function.json"},{"slug":"pickbasic-flashbasic/percent-lseek-function","title":"%lseek() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %lseek() function moves the read/write pointer. See your host OS system documentation.","url":"https://d3codex.com/pickbasic-flashbasic/percent-lseek-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-lseek-function.json"},{"slug":"pickbasic-flashbasic/percent-malloc-function","title":"%malloc() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %malloc() function allocates a memory block of size bytes and returns the address of this block.","url":"https://d3codex.com/pickbasic-flashbasic/percent-malloc-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-malloc-function.json"},{"slug":"pickbasic-flashbasic/percent-memccpy-function","title":"%memccpy() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Copies the memory area.","url":"https://d3codex.com/pickbasic-flashbasic/percent-memccpy-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-memccpy-function.json"},{"slug":"pickbasic-flashbasic/percent-memchr-function","title":"%memchr() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Scans memory for a character.","url":"https://d3codex.com/pickbasic-flashbasic/percent-memchr-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-memchr-function.json"},{"slug":"pickbasic-flashbasic/percent-memcopy-function","title":"%memcopy() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %memcopy() function copies characters from the memory area specified by s2 into s1, stopping after the first occurrence of the character designated by character has been copied, or after the number of characters specified by length have been copied, whichever comes first.","url":"https://d3codex.com/pickbasic-flashbasic/percent-memcopy-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-memcopy-function.json"},{"slug":"pickbasic-flashbasic/percent-memcpy-function","title":"%memcpy() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %memcpy() function copies the number of characters specified by number from memory area s2 into s1.","url":"https://d3codex.com/pickbasic-flashbasic/percent-memcpy-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-memcpy-function.json"},{"slug":"pickbasic-flashbasic/percent-memxcpy-function","title":"%memxcpy() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %memxcpy() function copies a specified number of characters from memory area s2 into s1, and converts each input character into two ASCII hexadecimal characters 0 through 9 and A through F.","url":"https://d3codex.com/pickbasic-flashbasic/percent-memxcpy-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-memxcpy-function.json"},{"slug":"pickbasic-flashbasic/percent-open-function","title":"%open() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %open() function opens the host OS file specified by str and sets the file status flags according to the value of oflag.","url":"https://d3codex.com/pickbasic-flashbasic/percent-open-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-open-function.json"},{"slug":"pickbasic-flashbasic/percent-pause-function","title":"%pause() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %pause() function suspends the calling process until it receives a signal.","url":"https://d3codex.com/pickbasic-flashbasic/percent-pause-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-pause-function.json"},{"slug":"pickbasic-flashbasic/percent-pclose-function","title":"%pclose() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %pclose() function closes the stream designated by stream opened by a %popen() and returns the exit status of the command.","url":"https://d3codex.com/pickbasic-flashbasic/percent-pclose-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-pclose-function.json"},{"slug":"pickbasic-flashbasic/percent-pgetpid-function","title":"%pgetpid() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %pgetpid() function returns the UNIX Process-ID (PID) associated to the D3 process line.","url":"https://d3codex.com/pickbasic-flashbasic/percent-pgetpid-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-pgetpid-function.json"},{"slug":"pickbasic-flashbasic/percent-popen-function","title":"%popen() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %popen() function creates a pipe between the calling process and the command to be executed.","url":"https://d3codex.com/pickbasic-flashbasic/percent-popen-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-popen-function.json"},{"slug":"pickbasic-flashbasic/percent-printf-function","title":"%printf() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Formatted output conversion.","url":"https://d3codex.com/pickbasic-flashbasic/percent-printf-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-printf-function.json"},{"slug":"pickbasic-flashbasic/percent-putenv-function","title":"%putenv() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %putenv() function makes the value of the environment variable name equal to the value designated by str, by altering an existing variable or by creating a new one.","url":"https://d3codex.com/pickbasic-flashbasic/percent-putenv-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-putenv-function.json"},{"slug":"pickbasic-flashbasic/percent-rdhex-function","title":"%rdhex() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %rdhex() function reads the number of bytes designated by (size * 2) into var from the file specified in file.descriptor, converting each byte into two ASCII hexadecimal characters.","url":"https://d3codex.com/pickbasic-flashbasic/percent-rdhex-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-rdhex-function.json"},{"slug":"pickbasic-flashbasic/percent-read-function","title":"%read() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %read() function reads the number of bytes designated in size into var, from the file specified by file.descriptor. This file is returned by a previous call to %open(), %creat(), or %dup().","url":"https://d3codex.com/pickbasic-flashbasic/percent-read-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-read-function.json"},{"slug":"pickbasic-flashbasic/percent-read-ssl-function","title":"%read_ssl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %read_ssl() function reads the number of bytes designated in size into var, from the Secure connection specified by ssl_fd descriptor. This descriptor is returned by a previous call to %accept_ssl() or %connect_ssl.","url":"https://d3codex.com/pickbasic-flashbasic/percent-read-ssl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-read-ssl-function.json"},{"slug":"pickbasic-flashbasic/percent-readregistry-function","title":"%readregistry() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %readregistry() function retrieves string values from the registry.","url":"https://d3codex.com/pickbasic-flashbasic/percent-readregistry-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-readregistry-function.json"},{"slug":"pickbasic-flashbasic/percent-realloc-function","title":"%realloc() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %realloc() function resizes the memory buffer specified to the specified size in bytes and returns a pointer to the resized buffer. The contents of the buffer are not changed. If buffer is null, this function behaves like the %malloc() function for the specified size. If the specified size is zero and the specified buffer is not null, the buffer memory is freed.","url":"https://d3codex.com/pickbasic-flashbasic/percent-realloc-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-realloc-function.json"},{"slug":"pickbasic-flashbasic/percent-recv-function","title":"%recv() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %recv() function receives data from a connected socket or a bound connectionless socket.","url":"https://d3codex.com/pickbasic-flashbasic/percent-recv-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-recv-function.json"},{"slug":"pickbasic-flashbasic/percent-recvfrom-function","title":"%recvfrom() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %recvfrom() function receives a datagram from a bound socket and stores the information on the sender. If no errors occur, the number of bytes received is returned.","url":"https://d3codex.com/pickbasic-flashbasic/percent-recvfrom-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-recvfrom-function.json"},{"slug":"pickbasic-flashbasic/percent-semctl-function","title":"%semctl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %semctl() function performs semaphore control operations.","url":"https://d3codex.com/pickbasic-flashbasic/percent-semctl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-semctl-function.json"},{"slug":"pickbasic-flashbasic/percent-semget-function","title":"%semget() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %semget() function creates a semaphore set.","url":"https://d3codex.com/pickbasic-flashbasic/percent-semget-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-semget-function.json"},{"slug":"pickbasic-flashbasic/percent-semop-function","title":"%semop() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %semop() function performs an array of semaphore operations on a set of semaphores.","url":"https://d3codex.com/pickbasic-flashbasic/percent-semop-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-semop-function.json"},{"slug":"pickbasic-flashbasic/percent-send-function","title":"%send() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %send() function sends data on a connected socket.","url":"https://d3codex.com/pickbasic-flashbasic/percent-send-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-send-function.json"},{"slug":"pickbasic-flashbasic/percent-sendto-function","title":"%sendto() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %sendto() sends data to a specified destination. If no errors occur, the total number of bytes sent is returned.","url":"https://d3codex.com/pickbasic-flashbasic/percent-sendto-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-sendto-function.json"},{"slug":"pickbasic-flashbasic/percent-setflush-function","title":"%setflush() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %setflush() function sets the flush periods.","url":"https://d3codex.com/pickbasic-flashbasic/percent-setflush-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-setflush-function.json"},{"slug":"pickbasic-flashbasic/percent-setsockopt-function","title":"%setsockopt() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %setsockopt() function sets a socket option.","url":"https://d3codex.com/pickbasic-flashbasic/percent-setsockopt-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-setsockopt-function.json"},{"slug":"pickbasic-flashbasic/percent-shell-function","title":"%shell() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %shell() function executes the MS-DOS command, command, and returns the exit code of the command.","url":"https://d3codex.com/pickbasic-flashbasic/percent-shell-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-shell-function.json"},{"slug":"pickbasic-flashbasic/percent-shellcapture-function","title":"%shellcapture() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %shellcapture() function executes the MS-DOS command, command, and captures the result in the buffer variable, up to the maximum size. If the buffer is not large enough, the exceeding output is discarded.","url":"https://d3codex.com/pickbasic-flashbasic/percent-shellcapture-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-shellcapture-function.json"},{"slug":"pickbasic-flashbasic/percent-shmat-function","title":"%shmat() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %shmat() function attaches a shared memory segment associated with the shared memory identifier shmid and returns the address of the segment.","url":"https://d3codex.com/pickbasic-flashbasic/percent-shmat-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-shmat-function.json"},{"slug":"pickbasic-flashbasic/percent-shmctl-function","title":"%shmctl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Allows the user to receive information on a shared memory segment, set the owner, group, and permissions of a shared memory segment, or destroy a segment.","url":"https://d3codex.com/pickbasic-flashbasic/percent-shmctl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-shmctl-function.json"},{"slug":"pickbasic-flashbasic/percent-shmdt-function","title":"%shmdt() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %shmdt() function detaches the shared memory segment located at the address specified by shmaddr.","url":"https://d3codex.com/pickbasic-flashbasic/percent-shmdt-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-shmdt-function.json"},{"slug":"pickbasic-flashbasic/percent-shmget-function","title":"%shmget() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %shmget() function creates a shared memory segment and returns a shared memory identifier.","url":"https://d3codex.com/pickbasic-flashbasic/percent-shmget-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-shmget-function.json"},{"slug":"pickbasic-flashbasic/percent-shutdown-function","title":"%shutdown() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %shutdown() function disables sends or receives on a socket.","url":"https://d3codex.com/pickbasic-flashbasic/percent-shutdown-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-shutdown-function.json"},{"slug":"pickbasic-flashbasic/percent-socket-function","title":"%socket() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %socket() function creates a socket in the specified addr.family and of the specified type. A protocol can be specified or assigned by the system. If the protocol is left unspecified (with a value of 0), the system selects an appropriate protocol in the specified addr.family.","url":"https://d3codex.com/pickbasic-flashbasic/percent-socket-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-socket-function.json"},{"slug":"pickbasic-flashbasic/percent-sprintf-function","title":"%sprintf() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Formatted output conversion.","url":"https://d3codex.com/pickbasic-flashbasic/percent-sprintf-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-sprintf-function.json"},{"slug":"pickbasic-flashbasic/percent-startfileio-function","title":"%startfileio() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Specifies that all input comes from the input file and all output goes to the output file.","url":"https://d3codex.com/pickbasic-flashbasic/percent-startfileio-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-startfileio-function.json"},{"slug":"pickbasic-flashbasic/percent-startlistilocks-function","title":"%startlistilocks() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %startlistilocks() function prepares for calls to the %listitemlocksfilter() function and the %endlistilocks() function.","url":"https://d3codex.com/pickbasic-flashbasic/percent-startlistilocks-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-startlistilocks-function.json"},{"slug":"pickbasic-flashbasic/percent-stopfileio-function","title":"%stopfileio() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Stops all input and output to and from the file. The FlashBASIC tab of the D3 Device Manager contains the default path of the input and output files (see the D3 System Administration Guide for more information).","url":"https://d3codex.com/pickbasic-flashbasic/percent-stopfileio-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-stopfileio-function.json"},{"slug":"pickbasic-flashbasic/percent-strcat-function","title":"%strcat() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Concatenates two strings.","url":"https://d3codex.com/pickbasic-flashbasic/percent-strcat-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-strcat-function.json"},{"slug":"pickbasic-flashbasic/percent-strcpy-function","title":"%strcpy() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Copies a string.","url":"https://d3codex.com/pickbasic-flashbasic/percent-strcpy-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-strcpy-function.json"},{"slug":"pickbasic-flashbasic/percent-strlen-function","title":"%strlen() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Calculates the length of a string.","url":"https://d3codex.com/pickbasic-flashbasic/percent-strlen-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-strlen-function.json"},{"slug":"pickbasic-flashbasic/percent-ttyname-function","title":"%ttyname() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %ttyname() function returns a pointer to a static area containing the null terminated path name of the terminal device associated to the file descriptor fd.","url":"https://d3codex.com/pickbasic-flashbasic/percent-ttyname-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-ttyname-function.json"},{"slug":"pickbasic-flashbasic/percent-unlink-function","title":"%unlink ()function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %unlink() function removes the directory entry named by the path name pointed to by path. The named file is unlinked, and when all the links have been removed, and the file is no longer open, the file is removed.","url":"https://d3codex.com/pickbasic-flashbasic/percent-unlink-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-unlink-function.json"},{"slug":"pickbasic-flashbasic/percent-wait-function","title":"%wait() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %wait() function returns the exit code of the child processes created by the current process.","url":"https://d3codex.com/pickbasic-flashbasic/percent-wait-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-wait-function.json"},{"slug":"pickbasic-flashbasic/percent-whex-function","title":"%whex() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %whex() function writes to the file specified by file.descriptor returned by a previous call to %open(), %creat(), or %dup() a string of bytes resulting from converting the ASCII string variable into binary.","url":"https://d3codex.com/pickbasic-flashbasic/percent-whex-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-whex-function.json"},{"slug":"pickbasic-flashbasic/percent-write-function","title":"%write() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %write() function writes the number of bytes designated by size from var to the file specified by file.descriptor returned by a previous call to %open(), %creat(), or %dup().","url":"https://d3codex.com/pickbasic-flashbasic/percent-write-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-write-function.json"},{"slug":"pickbasic-flashbasic/percent-write-ssl-function","title":"%write_ssl() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The %write_ssl() function writes the number of bytes designated by size from var to the Secure connection specified by ssl_fd descriptor. This descriptor is returned by a previous call to %accept_ssl() or %connect_ssl.","url":"https://d3codex.com/pickbasic-flashbasic/percent-write-ssl-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/percent-write-ssl-function.json"},{"slug":"pickbasic-flashbasic/performance","title":"Performance","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"There are three methods for increasing performance:","url":"https://d3codex.com/pickbasic-flashbasic/performance/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/performance.json"},{"slug":"pickbasic-flashbasic/plus-arithmetic-operator","title":"+ arithmetic operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The + arithmetic operator performs addition or indicates a positive numeric value.","url":"https://d3codex.com/pickbasic-flashbasic/plus-arithmetic-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/plus-arithmetic-operator.json"},{"slug":"pickbasic-flashbasic/plus-equals-assignment-operator","title":"+= assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The += assignment operator adds a given numeric expression and assigns it to the given variable.","url":"https://d3codex.com/pickbasic-flashbasic/plus-equals-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/plus-equals-assignment-operator.json"},{"slug":"pickbasic-flashbasic/pound-relational-pperator","title":"# relational operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The # relational operator signifies not equal to.","url":"https://d3codex.com/pickbasic-flashbasic/pound-relational-pperator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/pound-relational-pperator.json"},{"slug":"pickbasic-flashbasic/precedence","title":"Precedence","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Precedence is the set of rules imposed upon the evaluation of components of an expression that are not otherwise overridden by the presence of parentheses.","url":"https://d3codex.com/pickbasic-flashbasic/precedence/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/precedence.json"},{"slug":"pickbasic-flashbasic/precision-statement","title":"precision statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The precision statement defines the number of fractional decimal places that a numerical value can hold.","url":"https://d3codex.com/pickbasic-flashbasic/precision-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/precision-statement.json"},{"slug":"pickbasic-flashbasic/print-on-statement","title":"print on statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The print on statement directs output to one of 32,767 open print files.","url":"https://d3codex.com/pickbasic-flashbasic/print-on-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/print-on-statement.json"},{"slug":"pickbasic-flashbasic/print-statement","title":"print statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The print statement directs output of an expression to the current output device.","url":"https://d3codex.com/pickbasic-flashbasic/print-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/print-statement.json"},{"slug":"pickbasic-flashbasic/printchar-statement","title":"printchar statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The printchar statement prints the first character of the string expression to the screen or to the printer.","url":"https://d3codex.com/pickbasic-flashbasic/printchar-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/printchar-statement.json"},{"slug":"pickbasic-flashbasic/printer-statement","title":"printer statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The printer statement controls the output from subsequent print, heading, footing, or page statements.","url":"https://d3codex.com/pickbasic-flashbasic/printer-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/printer-statement.json"},{"slug":"pickbasic-flashbasic/printerr-statement","title":"printerr statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The printerr statement allows BASIC programs to produce output messages using the Error Message Processor and the errmsg file.","url":"https://d3codex.com/pickbasic-flashbasic/printerr-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/printerr-statement.json"},{"slug":"pickbasic-flashbasic/procread-statement","title":"procread statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The procread statement reads the calling Proc’s primary input buffer and assigns its contents to a specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/procread-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/procread-statement.json"},{"slug":"pickbasic-flashbasic/procwrite-statement","title":"procwrite statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The procwrite statement writes a string expression variable to the calling Proc’s primary input buffer.","url":"https://d3codex.com/pickbasic-flashbasic/procwrite-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/procwrite-statement.json"},{"slug":"pickbasic-flashbasic/program-statement","title":"program statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The program statement is optionally used on the first line of a program to indicate that this is a program.","url":"https://d3codex.com/pickbasic-flashbasic/program-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/program-statement.json"},{"slug":"pickbasic-flashbasic/prompt-statement","title":"prompt statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The prompt statement indicates the single character to display during subsequent input statements that prompt for input from the keyboard.","url":"https://d3codex.com/pickbasic-flashbasic/prompt-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/prompt-statement.json"},{"slug":"pickbasic-flashbasic/prvkey-statement","title":"prvkey statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The prvkey statement operates in the same manner as the nxtkey statement with the exception that the keys returned are those previous to the beginning key value key.","url":"https://d3codex.com/pickbasic-flashbasic/prvkey-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/prvkey-statement.json"},{"slug":"pickbasic-flashbasic/pwr-function","title":"pwr() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The pwr() function raises a value contained in an expression to the power of the value of a second expression.","url":"https://d3codex.com/pickbasic-flashbasic/pwr-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/pwr-function.json"},{"slug":"pickbasic-flashbasic/quotes-reserved-character","title":"\" Reserved Character","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The \" reserved character marks the beginning or ending of a literal string in FlashBASIC or BASIC.","url":"https://d3codex.com/pickbasic-flashbasic/quotes-reserved-character/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/quotes-reserved-character.json"},{"slug":"pickbasic-flashbasic/read-statement","title":"read statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The read statement reads an item as a dynamic array and stores the item as a string. Each attribute is automatically an element of the dynamic array variable and can be referenced with the appropriate intrinsic functions.","url":"https://d3codex.com/pickbasic-flashbasic/read-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/read-statement.json"},{"slug":"pickbasic-flashbasic/readf-statement","title":"readf statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The readf statement reads the specified number of characters from a normal item.","url":"https://d3codex.com/pickbasic-flashbasic/readf-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/readf-statement.json"},{"slug":"pickbasic-flashbasic/readnext-statement","title":"readnext statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The readnext statement retrieves the next item-ID from an active list and assigns it to a specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/readnext-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/readnext-statement.json"},{"slug":"pickbasic-flashbasic/readt-statement","title":"readt statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The readt statement reads a tape record and assigns the value returned to a specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/readt-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/readt-statement.json"},{"slug":"pickbasic-flashbasic/readtx-statement","title":"readtx statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The readtx statement reads a tape record, converts the tape record to hexadecimal, and assigns the resulting hexadecimal value to a specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/readtx-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/readtx-statement.json"},{"slug":"pickbasic-flashbasic/readv-statement","title":"readv statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The readv statement reads an item from the optionally-specified file variable and assigns the value contained in the attribute number referenced in the attribute expression to the specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/readv-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/readv-statement.json"},{"slug":"pickbasic-flashbasic/recompiling-a-trigger","title":"Recompiling a trigger","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"By default, when the FlashBASIC code for a trigger is recompiled, it is not immediately used by the application. All files using the trigger must be closed for the new copy of the code to be taken into account.","url":"https://d3codex.com/pickbasic-flashbasic/recompiling-a-trigger/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/recompiling-a-trigger.json"},{"slug":"pickbasic-flashbasic/relational-expressions","title":"Relational expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A relational expression evaluates to 1 if the relation is true, and evaluates to 0 if the relation is false. Relational operators have lower precedence than all arithmetic and string operators. Therefore, relational operators are only evaluated after all arithmetic and string operations have been evaluated.","url":"https://d3codex.com/pickbasic-flashbasic/relational-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/relational-expressions.json"},{"slug":"pickbasic-flashbasic/relational-operators","title":"Relational operators","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Relational operators are used to compare both strings and/or numerics.","url":"https://d3codex.com/pickbasic-flashbasic/relational-operators/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/relational-operators.json"},{"slug":"pickbasic-flashbasic/release-statement","title":"release statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The release statement clears locks on items locked with a previous matreadu, readu, or readvu statement.","url":"https://d3codex.com/pickbasic-flashbasic/release-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/release-statement.json"},{"slug":"pickbasic-flashbasic/rem-function","title":"rem() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The rem() function returns the remainder portion of the result of dividing one number by another.","url":"https://d3codex.com/pickbasic-flashbasic/rem-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/rem-function.json"},{"slug":"pickbasic-flashbasic/rem-statement","title":"rem statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The rem statement designates that all text that follows the statement on the same line is ignored by the compiler.","url":"https://d3codex.com/pickbasic-flashbasic/rem-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/rem-statement.json"},{"slug":"pickbasic-flashbasic/remove-statement","title":"remove statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The remove statement retrieves a substring delimited by a system delimiter from a dynamic array.","url":"https://d3codex.com/pickbasic-flashbasic/remove-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/remove-statement.json"},{"slug":"pickbasic-flashbasic/repeat-statement","title":"repeat statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The repeat statement defines the end of a loop. See loop statement for more information.","url":"https://d3codex.com/pickbasic-flashbasic/repeat-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/repeat-statement.json"},{"slug":"pickbasic-flashbasic/replace-function","title":"replace() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The replace() function inserts or replaces a specific attribute, value, or subvalue in the string referenced by dyn.array.exp with the value referenced in str.exp.","url":"https://d3codex.com/pickbasic-flashbasic/replace-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/replace-function.json"},{"slug":"pickbasic-flashbasic/replace-statement","title":"replace statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The replace statement maintains referential integrity between items that contain bidirectional bridges used by the Update processor by eliminating duplicate item-IDs.","url":"https://d3codex.com/pickbasic-flashbasic/replace-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/replace-statement.json"},{"slug":"pickbasic-flashbasic/reserved-characters","title":"Reserved characters","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Reserved characters are the characters that are reserved for special purposes.","url":"https://d3codex.com/pickbasic-flashbasic/reserved-characters/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/reserved-characters.json"},{"slug":"pickbasic-flashbasic/reserved-words","title":"Reserved words","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The rules for reserved words are:","url":"https://d3codex.com/pickbasic-flashbasic/reserved-words/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/reserved-words.json"},{"slug":"pickbasic-flashbasic/retrieval-locks","title":"Retrieval locks","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"If a BASIC program is run by a user that does not have retrieval or update privileges (for a file that does and is opened in the program), and then attempts to read and/or write to that file, the program terminates with an error message. In order to read or write to such a file, users must make sure that the retrieval and update lock codes match those of the file that is opened. This is a system function and cannot be accomplished from BASIC. If the file is retrieval protected, the file cannot be opened and the program is terminated with an error message.","url":"https://d3codex.com/pickbasic-flashbasic/retrieval-locks/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/retrieval-locks.json"},{"slug":"pickbasic-flashbasic/return-statement","title":"return statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The return statement terminates an internal or external subroutine, and returns execution control to the statement following the invoking call or gosub statement.","url":"https://d3codex.com/pickbasic-flashbasic/return-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/return-statement.json"},{"slug":"pickbasic-flashbasic/rewind-statement","title":"rewind statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The rewind statement rewinds the currently attached magnetic tape unit to the beginning of the tape.","url":"https://d3codex.com/pickbasic-flashbasic/rewind-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/rewind-statement.json"},{"slug":"pickbasic-flashbasic/rnd-function","title":"rnd() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The rnd() function generates a random number.","url":"https://d3codex.com/pickbasic-flashbasic/rnd-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/rnd-function.json"},{"slug":"pickbasic-flashbasic/rollback-work-statement","title":"rollback work statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The rollback work statement rolls back (or undoes) a transaction.","url":"https://d3codex.com/pickbasic-flashbasic/rollback-work-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/rollback-work-statement.json"},{"slug":"pickbasic-flashbasic/root-statement","title":"root statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The root statement provides an interface to the B-tree indexes for subsequent references with the key statement.","url":"https://d3codex.com/pickbasic-flashbasic/root-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/root-statement.json"},{"slug":"pickbasic-flashbasic/rqm-statement","title":"rqm statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The rqm statement suspends processing for a specific number of seconds, or until a specific time.","url":"https://d3codex.com/pickbasic-flashbasic/rqm-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/rqm-statement.json"},{"slug":"pickbasic-flashbasic/running-a-flashbasic-module","title":"Running a FlashBASIC module","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Once compiled, the BASIC object code can be run directly, or it can be cataloged. This topic explains how to run a BASIC module.","url":"https://d3codex.com/pickbasic-flashbasic/running-a-flashbasic-module/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/running-a-flashbasic-module.json"},{"slug":"pickbasic-flashbasic/running-flashbasic-from-a-windows-command-prompt","title":"Running FlashBASIC from a Windows command prompt","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"BASIC object code can be exported to a DOS file with a .D3F extension, and then combined with a launcher to turn it into an executable that can be run directly from a Windows command prompt. It is also possible to configure Windows to recognize the .D3F extension as an executable and associate it with the Flash interpreter (see Notes below), which makes the Flash module significantly smaller.","url":"https://d3codex.com/pickbasic-flashbasic/running-flashbasic-from-a-windows-command-prompt/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/running-flashbasic-from-a-windows-command-prompt.json"},{"slug":"pickbasic-flashbasic/running-flashbasic-from-visual-basic","title":"Running FlashBASIC from Visual Basic","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"When using a FlashBASIC module with the D3 Visual Basic class, D3clsRuleModule, some differences and constraints are applied due to the differences between the Windows and D3 environments.","url":"https://d3codex.com/pickbasic-flashbasic/running-flashbasic-from-visual-basic/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/running-flashbasic-from-visual-basic.json"},{"slug":"pickbasic-flashbasic/scan-function","title":"scan() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The scan() function searches through a specified str.exp for the first occurrence of up to three user-definable characters specified by search.delimiters, in addition to the system delimiters value, subvalue, and attribute.","url":"https://d3codex.com/pickbasic-flashbasic/scan-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/scan-function.json"},{"slug":"pickbasic-flashbasic/screen-display-utility","title":"screen.display utility","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The screen.display utility displays a screen and waits for a selection.","url":"https://d3codex.com/pickbasic-flashbasic/screen-display-utility/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/screen-display-utility.json"},{"slug":"pickbasic-flashbasic/screen-erase-utility","title":"screen.erase utility","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The screen.erase utility erases a formatted screen.","url":"https://d3codex.com/pickbasic-flashbasic/screen-erase-utility/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/screen-erase-utility.json"},{"slug":"pickbasic-flashbasic/screen-init-utility","title":"screen.init utility","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The screen.init utility initializes the screen common workspace. This call should be done prior to any other call the screen subroutines.","url":"https://d3codex.com/pickbasic-flashbasic/screen-init-utility/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/screen-init-utility.json"},{"slug":"pickbasic-flashbasic/screen-input-utility","title":"screen.input utility","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The screen.input utility displays a formatted screen and waits for input from a user. Multiple fields can be entered by the user before validation. Type checking is done by the subroutine, and the caller can provide a custom external routine to perform additional controls.","url":"https://d3codex.com/pickbasic-flashbasic/screen-input-utility/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/screen-input-utility.json"},{"slug":"pickbasic-flashbasic/select-statement","title":"select statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The select statement creates an active list of item-IDs, allowing sequential access to each item in the file by use of the readnext statement.","url":"https://d3codex.com/pickbasic-flashbasic/select-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/select-statement.json"},{"slug":"pickbasic-flashbasic/semicolon-reserved-character","title":"; reserved character","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ; (semicolon) reserved character separates multiple FlashBASIC or BASIC statements on a single line.","url":"https://d3codex.com/pickbasic-flashbasic/semicolon-reserved-character/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/semicolon-reserved-character.json"},{"slug":"pickbasic-flashbasic/send-statement","title":"send statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The send statement sends output to a specified port.","url":"https://d3codex.com/pickbasic-flashbasic/send-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/send-statement.json"},{"slug":"pickbasic-flashbasic/sendx-statement","title":"sendx statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The sendx statement converts the exploded ASCII hexadecimal string results of str.exp to its binary equivalent and then transmits it to the specified port. The conversion process terminates when the first nonhexadecimal character is encountered. sendx suppresses the output of a CR/LF pair. sendx does not allow the : to exist as part of the statement.","url":"https://d3codex.com/pickbasic-flashbasic/sendx-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/sendx-statement.json"},{"slug":"pickbasic-flashbasic/sentence-function","title":"sentence() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The sentence() function is identical to performing a tclread statement. It returns the TCL command used to activate the program into a variable.","url":"https://d3codex.com/pickbasic-flashbasic/sentence-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/sentence-function.json"},{"slug":"pickbasic-flashbasic/seq-function","title":"seq() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The seq() function converts any ASCII character to its corresponding numeric equivalent in the range 0 through 255.","url":"https://d3codex.com/pickbasic-flashbasic/seq-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/seq-function.json"},{"slug":"pickbasic-flashbasic/setting-clause","title":"setting clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The setting clause defines the variable to receive the index results of a get or locate statement.","url":"https://d3codex.com/pickbasic-flashbasic/setting-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/setting-clause.json"},{"slug":"pickbasic-flashbasic/sin-function","title":"sin() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The sin() function calculates the sine of an angle specified in degrees.","url":"https://d3codex.com/pickbasic-flashbasic/sin-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/sin-function.json"},{"slug":"pickbasic-flashbasic/slash-arithmetic-operator","title":"/ arithmetic operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The / arithmetic operator performs division.","url":"https://d3codex.com/pickbasic-flashbasic/slash-arithmetic-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/slash-arithmetic-operator.json"},{"slug":"pickbasic-flashbasic/slash-equals-assignment-operator","title":"/= assignment operator","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The /= assignment operator divides a variable by a numeric expression and assigns it to the given variable.","url":"https://d3codex.com/pickbasic-flashbasic/slash-equals-assignment-operator/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/slash-equals-assignment-operator.json"},{"slug":"pickbasic-flashbasic/sleep-statement","title":"sleep statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The sleep statement places a process to sleep for a specific number of seconds, or, until a specific time.","url":"https://d3codex.com/pickbasic-flashbasic/sleep-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/sleep-statement.json"},{"slug":"pickbasic-flashbasic/sort-function","title":"sort() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The sort() function sorts an attribute or value mark delimited str.exp in ascending order.","url":"https://d3codex.com/pickbasic-flashbasic/sort-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/sort-function.json"},{"slug":"pickbasic-flashbasic/soundex-function","title":"soundex() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The soundex() function returns the 4-digit soundex code for a phonetic string expression.","url":"https://d3codex.com/pickbasic-flashbasic/soundex-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/soundex-function.json"},{"slug":"pickbasic-flashbasic/space-function","title":"space() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The space() function generates a string of spaces of a length equal to the value of the numeric expression.","url":"https://d3codex.com/pickbasic-flashbasic/space-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/space-function.json"},{"slug":"pickbasic-flashbasic/spoolq-statement","title":"spoolq statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The spoolq statement enables or disables the spooler entry number message.","url":"https://d3codex.com/pickbasic-flashbasic/spoolq-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/spoolq-statement.json"},{"slug":"pickbasic-flashbasic/sqrt-function","title":"sqrt() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The sqrt() function calculates the square root of a given numeric expression.","url":"https://d3codex.com/pickbasic-flashbasic/sqrt-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/sqrt-function.json"},{"slug":"pickbasic-flashbasic/squote-function","title":"squote() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The squote() function extracts a single-quoted string from str.exp.","url":"https://d3codex.com/pickbasic-flashbasic/squote-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/squote-function.json"},{"slug":"pickbasic-flashbasic/statement-blocks","title":"statement blocks","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A statement block is one or more statements that follow a BASIC decision-path related token such as, but not limited to, then, else, locked, and onerr.","url":"https://d3codex.com/pickbasic-flashbasic/statement-blocks/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/statement-blocks.json"},{"slug":"pickbasic-flashbasic/statement-labels","title":"statement labels","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"statement labels are used as the destination of a goto or gosub statement.","url":"https://d3codex.com/pickbasic-flashbasic/statement-labels/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/statement-labels.json"},{"slug":"pickbasic-flashbasic/statements-and-functions","title":"Statements and functions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"This topic describes the differences between statements and functions in BASIC and provides working definitions of variables, constants, labels, spaces, and program formatting.","url":"https://d3codex.com/pickbasic-flashbasic/statements-and-functions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/statements-and-functions.json"},{"slug":"pickbasic-flashbasic/status-function","title":"status() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The status() function returns the value of system(0).","url":"https://d3codex.com/pickbasic-flashbasic/status-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/status-function.json"},{"slug":"pickbasic-flashbasic/stop-statement","title":"stop statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The stop statement stops program execution and returns to the invoking the process.","url":"https://d3codex.com/pickbasic-flashbasic/stop-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/stop-statement.json"},{"slug":"pickbasic-flashbasic/str-function","title":"str() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The str() function repeats a str.exp the number of times specified in num.exp.","url":"https://d3codex.com/pickbasic-flashbasic/str-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/str-function.json"},{"slug":"pickbasic-flashbasic/string-expressions","title":"String expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A string expression is any expression that evaluates to, or can be converted to a string of characters.","url":"https://d3codex.com/pickbasic-flashbasic/string-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/string-expressions.json"},{"slug":"pickbasic-flashbasic/subroutine-statement","title":"subroutine statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The subroutine statement defines a program as an external subroutine.","url":"https://d3codex.com/pickbasic-flashbasic/subroutine-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/subroutine-statement.json"},{"slug":"pickbasic-flashbasic/substring-expressions","title":"Substring expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A substring expression extracts or assigns substrings by using the [ and ] characters.","url":"https://d3codex.com/pickbasic-flashbasic/substring-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/substring-expressions.json"},{"slug":"pickbasic-flashbasic/substrings","title":"Substrings","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A substring is a set of characters that makes up part of a whole string. The syntax to specify a substring is:","url":"https://d3codex.com/pickbasic-flashbasic/substrings/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/substrings.json"},{"slug":"pickbasic-flashbasic/subvalue-count-expressions","title":"Subvalue count expressions","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A subvalue count expression (sc expression) is an expression that evaluates to a valid subvalue count.","url":"https://d3codex.com/pickbasic-flashbasic/subvalue-count-expressions/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/subvalue-count-expressions.json"},{"slug":"pickbasic-flashbasic/sum-function","title":"sum() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The sum() function returns the sum of a list of numbers delimited by attribute, value, or subvalue marks. If different orders of marks are present, the sum() function computes the sum of each sublist.","url":"https://d3codex.com/pickbasic-flashbasic/sum-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/sum-function.json"},{"slug":"pickbasic-flashbasic/summation-function","title":"summation() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The summation() function returns the sum of a list of numbers delimited by attribute, value, or subvalue marks.","url":"https://d3codex.com/pickbasic-flashbasic/summation-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/summation-function.json"},{"slug":"pickbasic-flashbasic/swap-function","title":"swap() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The swap() function searches a str.exp for the search.str. If the search.str is at the start occurrence, then replacement.str replaces search.str for the amount specified in occurrences.","url":"https://d3codex.com/pickbasic-flashbasic/swap-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/swap-function.json"},{"slug":"pickbasic-flashbasic/symbol-table-basic","title":"Symbol table (BASIC)","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"When a BASIC program is compiled, a symbol table is generated, unless the s (suppress table) option has been used with the compile or basic. The symbol table is used by the BASIC debugger to reference symbolic variables.","url":"https://d3codex.com/pickbasic-flashbasic/symbol-table-basic/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/symbol-table-basic.json"},{"slug":"pickbasic-flashbasic/system-function","title":"system() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The system() function provides an interface to a number of system variables, depending on the requested numeric argument.","url":"https://d3codex.com/pickbasic-flashbasic/system-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/system-function.json"},{"slug":"pickbasic-flashbasic/ta-function","title":"ta() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ta() function returns the number of characters in the type-ahead buffer for the current process or for any other process.","url":"https://d3codex.com/pickbasic-flashbasic/ta-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ta-function.json"},{"slug":"pickbasic-flashbasic/ta-statement","title":"ta statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ta statement toggles or resets the type-ahead buffer.","url":"https://d3codex.com/pickbasic-flashbasic/ta-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ta-statement.json"},{"slug":"pickbasic-flashbasic/tan-function","title":"tan() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The tan() function calculates the trigonometric tangent of the angle specified in degrees.","url":"https://d3codex.com/pickbasic-flashbasic/tan-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/tan-function.json"},{"slug":"pickbasic-flashbasic/tcl-statement","title":"tcl statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The tcl statement executes any valid TCL command as a subroutine.","url":"https://d3codex.com/pickbasic-flashbasic/tcl-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/tcl-statement.json"},{"slug":"pickbasic-flashbasic/tclread-statement","title":"tclread statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The tclread statement loads the TCL command used to activate the program into a variable.","url":"https://d3codex.com/pickbasic-flashbasic/tclread-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/tclread-statement.json"},{"slug":"pickbasic-flashbasic/then-clause","title":"then clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The then clause specifies which statements to execute when the conditional statement evaluates to true.","url":"https://d3codex.com/pickbasic-flashbasic/then-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/then-clause.json"},{"slug":"pickbasic-flashbasic/then-else-statement-blocks","title":"then/else statement blocks","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"then/else statement blocks are found in conjunction with conditional statements.","url":"https://d3codex.com/pickbasic-flashbasic/then-else-statement-blocks/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/then-else-statement-blocks.json"},{"slug":"pickbasic-flashbasic/time-function","title":"time() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The time() function returns the current system time in its internal format, representing the number of seconds past midnight.","url":"https://d3codex.com/pickbasic-flashbasic/time-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/time-function.json"},{"slug":"pickbasic-flashbasic/timedate-function","title":"timedate() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The timedate() function returns the current system time and date in external format (hh:mm:ss dd mmm yyyy).","url":"https://d3codex.com/pickbasic-flashbasic/timedate-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/timedate-function.json"},{"slug":"pickbasic-flashbasic/timeout-statement","title":"timeout statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"mvBase Only: The timeout statement specifies the number of seconds the operating environment waits for terminal input before a timeout condition occurs.","url":"https://d3codex.com/pickbasic-flashbasic/timeout-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/timeout-statement.json"},{"slug":"pickbasic-flashbasic/transaction-abort-statement","title":"transaction abort statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"transaction abort statement","url":"https://d3codex.com/pickbasic-flashbasic/transaction-abort-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/transaction-abort-statement.json"},{"slug":"pickbasic-flashbasic/transaction-cache-statement","title":"transaction cache statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The transaction cache statement enables or disables the transaction read cache.","url":"https://d3codex.com/pickbasic-flashbasic/transaction-cache-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/transaction-cache-statement.json"},{"slug":"pickbasic-flashbasic/transaction-commit-statement","title":"transaction commit statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"transaction commit statement","url":"https://d3codex.com/pickbasic-flashbasic/transaction-commit-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/transaction-commit-statement.json"},{"slug":"pickbasic-flashbasic/transaction-flush-statement","title":"transaction flush statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The transaction flush statement enables or disables the transaction flush mechanism.","url":"https://d3codex.com/pickbasic-flashbasic/transaction-flush-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/transaction-flush-statement.json"},{"slug":"pickbasic-flashbasic/transaction-rollback-function","title":"transaction rollback function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"transaction rollback function","url":"https://d3codex.com/pickbasic-flashbasic/transaction-rollback-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/transaction-rollback-function.json"},{"slug":"pickbasic-flashbasic/transaction-start-function","title":"transaction start function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"transaction start function","url":"https://d3codex.com/pickbasic-flashbasic/transaction-start-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/transaction-start-function.json"},{"slug":"pickbasic-flashbasic/transaction-statement","title":"transaction statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The transaction statement enables or disables participation in a transaction.","url":"https://d3codex.com/pickbasic-flashbasic/transaction-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/transaction-statement.json"},{"slug":"pickbasic-flashbasic/trim-function","title":"trim() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The trim() function removes leading, trailing, and/or redundant characters from a string.","url":"https://d3codex.com/pickbasic-flashbasic/trim-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/trim-function.json"},{"slug":"pickbasic-flashbasic/trimb-function","title":"trimb() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The trimb() function removes trailing spaces from a string.","url":"https://d3codex.com/pickbasic-flashbasic/trimb-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/trimb-function.json"},{"slug":"pickbasic-flashbasic/trimf-function","title":"trimf() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The trimf() function removes leading spaces from a string.","url":"https://d3codex.com/pickbasic-flashbasic/trimf-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/trimf-function.json"},{"slug":"pickbasic-flashbasic/u-pl-mon-data-user-exit","title":"u$pl.mon.data user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u$pl.mon.data user exit returns this monitor information:","url":"https://d3codex.com/pickbasic-flashbasic/u-pl-mon-data-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u-pl-mon-data-user-exit.json"},{"slug":"pickbasic-flashbasic/u0003-user-exit","title":"u0003 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0003 user exit returns the TCL command invoking the FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/u0003-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0003-user-exit.json"},{"slug":"pickbasic-flashbasic/u0004-user-exit","title":"u0004 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0004 user exit returns term settings in dynamic array format.","url":"https://d3codex.com/pickbasic-flashbasic/u0004-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0004-user-exit.json"},{"slug":"pickbasic-flashbasic/u0005-user-exit","title":"u0005 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0005 user exit clears the type-ahead buffer.","url":"https://d3codex.com/pickbasic-flashbasic/u0005-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0005-user-exit.json"},{"slug":"pickbasic-flashbasic/u000e-user-exit","title":"u000e user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u000e user exit gets the name of the current account.","url":"https://d3codex.com/pickbasic-flashbasic/u000e-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u000e-user-exit.json"},{"slug":"pickbasic-flashbasic/u0010-user-exit","title":"u0010 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0010 user exit creates a phantom process.","url":"https://d3codex.com/pickbasic-flashbasic/u0010-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0010-user-exit.json"},{"slug":"pickbasic-flashbasic/u0011-user-exit","title":"u0011 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0011 user exit gets the port number of the scheduler process.","url":"https://d3codex.com/pickbasic-flashbasic/u0011-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0011-user-exit.json"},{"slug":"pickbasic-flashbasic/u001c-user-exit","title":"u001c user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u001c user exit gets the number of attributes (elements) after a matread.","url":"https://d3codex.com/pickbasic-flashbasic/u001c-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u001c-user-exit.json"},{"slug":"pickbasic-flashbasic/u001e-user-exit","title":"u001e user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u001e user exit returns the checksum of a string.","url":"https://d3codex.com/pickbasic-flashbasic/u001e-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u001e-user-exit.json"},{"slug":"pickbasic-flashbasic/u001f-user-exit","title":"u001f user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u001f user exit returns the last shutdown status.","url":"https://d3codex.com/pickbasic-flashbasic/u001f-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u001f-user-exit.json"},{"slug":"pickbasic-flashbasic/u0033-user-exit","title":"u0033 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0033 user exit converts a decimal number into a Roman numeral.","url":"https://d3codex.com/pickbasic-flashbasic/u0033-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0033-user-exit.json"},{"slug":"pickbasic-flashbasic/u0039-user-exit","title":"u0039 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0039 user exit reads an absolute disk sector. This user exit provides more information than u14a.","url":"https://d3codex.com/pickbasic-flashbasic/u0039-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0039-user-exit.json"},{"slug":"pickbasic-flashbasic/u005b-user-exit","title":"u005b user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u005b user exit obtains and manipulates external strings, allowing the caller (likely non-FlashBASIC) to store data without writing to a file or storing it in BASIC string space. See xsuex User Exit for more information.","url":"https://d3codex.com/pickbasic-flashbasic/u005b-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u005b-user-exit.json"},{"slug":"pickbasic-flashbasic/u0074-user-exit","title":"u0074 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0074 is used to get a list of the VME item locks in a dynamic array format.","url":"https://d3codex.com/pickbasic-flashbasic/u0074-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0074-user-exit.json"},{"slug":"pickbasic-flashbasic/u0079-user-exit","title":"u0079 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0079 user exit returns the where status for the specified PCB (Process Control Block) FID, and its return stack information.","url":"https://d3codex.com/pickbasic-flashbasic/u0079-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0079-user-exit.json"},{"slug":"pickbasic-flashbasic/u007a-user-exit","title":"u007a user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u007A user exit updates a binary item from a FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/u007a-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u007a-user-exit.json"},{"slug":"pickbasic-flashbasic/u0089-user-exit","title":"u0089 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"User exit u0089 converts a hexadecimal number (in a string) to a binary number.","url":"https://d3codex.com/pickbasic-flashbasic/u0089-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0089-user-exit.json"},{"slug":"pickbasic-flashbasic/u009d-user-exit","title":"u009d user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u009d user exit encodes or decodes a string of characters.","url":"https://d3codex.com/pickbasic-flashbasic/u009d-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u009d-user-exit.json"},{"slug":"pickbasic-flashbasic/u009e-user-exit","title":"u009e user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u009e user exit replaces all occurrences of str1 with str2 in str3.","url":"https://d3codex.com/pickbasic-flashbasic/u009e-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u009e-user-exit.json"},{"slug":"pickbasic-flashbasic/u009f-user-exit","title":"u009f user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u009f user exit converts a binary number to a hexadecimal number (32-bit limit).","url":"https://d3codex.com/pickbasic-flashbasic/u009f-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u009f-user-exit.json"},{"slug":"pickbasic-flashbasic/u00b9-user-exit","title":"u00b9 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u00b9 user exit returns a soundex value for a specified string.","url":"https://d3codex.com/pickbasic-flashbasic/u00b9-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u00b9-user-exit.json"},{"slug":"pickbasic-flashbasic/u00ba-user-exit","title":"u00ba user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u00ba user exit performs BIOS INT 10 calls to change the video screen attributes on the console.","url":"https://d3codex.com/pickbasic-flashbasic/u00ba-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u00ba-user-exit.json"},{"slug":"pickbasic-flashbasic/u014a-user-exit","title":"u014a user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u014a user exit reads an absolute disk sector.","url":"https://d3codex.com/pickbasic-flashbasic/u014a-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u014a-user-exit.json"},{"slug":"pickbasic-flashbasic/u014b-user-exit","title":"u014b user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u014b user exit writes an absolute disk sector.","url":"https://d3codex.com/pickbasic-flashbasic/u014b-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u014b-user-exit.json"},{"slug":"pickbasic-flashbasic/u017e-user-exit","title":"u017e user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u017e user exit allows output of any character to the terminal or spooler.","url":"https://d3codex.com/pickbasic-flashbasic/u017e-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u017e-user-exit.json"},{"slug":"pickbasic-flashbasic/u01b6-user-exit","title":"u01b6 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u01b6 user exit converts a numeric expression to the number of units as defined by the TCL set-units, set-dozens, set-decimal, or set-thousands commands.","url":"https://d3codex.com/pickbasic-flashbasic/u01b6-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u01b6-user-exit.json"},{"slug":"pickbasic-flashbasic/u0209-user-exit","title":"u0209 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0209 user exit returns only alphabetical and numeric characters.","url":"https://d3codex.com/pickbasic-flashbasic/u0209-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0209-user-exit.json"},{"slug":"pickbasic-flashbasic/u0358-user-exit","title":"u0358 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0358 user exit allows character input combined with an eoi (end-of-input) character.","url":"https://d3codex.com/pickbasic-flashbasic/u0358-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0358-user-exit.json"},{"slug":"pickbasic-flashbasic/u0c-user-exit","title":"u0c user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0c user exit encrypts a password.","url":"https://d3codex.com/pickbasic-flashbasic/u0c-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u0c-user-exit.json"},{"slug":"pickbasic-flashbasic/u1072-user-exit","title":"u1072 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u1072 user exit returns a dynamic array, sorted in ascending order.","url":"https://d3codex.com/pickbasic-flashbasic/u1072-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u1072-user-exit.json"},{"slug":"pickbasic-flashbasic/u10b9-user-exit","title":"u10b9 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u10b9 user exit converts American currency punctuation ($1,000.00) to international punctuation (#1.000,00)","url":"https://d3codex.com/pickbasic-flashbasic/u10b9-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u10b9-user-exit.json"},{"slug":"pickbasic-flashbasic/u11b6-user-exit","title":"u11b6 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u11b6 user exit converts a unit expression to a numeric value as defined by the TCL set-units, set-dozens, set-decimal, or set-thousands commands.","url":"https://d3codex.com/pickbasic-flashbasic/u11b6-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u11b6-user-exit.json"},{"slug":"pickbasic-flashbasic/u1209-user-exit","title":"u1209 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u1209 user exit breaks a single line of text into multiple lines of text with each line being no longer than length characters. This function is similar to the t justification in AQL.","url":"https://d3codex.com/pickbasic-flashbasic/u1209-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u1209-user-exit.json"},{"slug":"pickbasic-flashbasic/u1a-user-exit","title":"u1a user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u1a user exit returns the tape block size.","url":"https://d3codex.com/pickbasic-flashbasic/u1a-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u1a-user-exit.json"},{"slug":"pickbasic-flashbasic/u1f-user-exit","title":"u1f user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u1f user exit returns a string of digits indicating the boot status.","url":"https://d3codex.com/pickbasic-flashbasic/u1f-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u1f-user-exit.json"},{"slug":"pickbasic-flashbasic/u20b9-user-exit","title":"u20b9 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u20b9 user exit converts international currency punctuation (#1.000,00) to American punctuation ($1,000.00).","url":"https://d3codex.com/pickbasic-flashbasic/u20b9-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u20b9-user-exit.json"},{"slug":"pickbasic-flashbasic/u21-user-exit","title":"u21 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u21 user exit converts upper case to lower case.","url":"https://d3codex.com/pickbasic-flashbasic/u21-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u21-user-exit.json"},{"slug":"pickbasic-flashbasic/u2117-user-exit","title":"u2117 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u2117 user exit returns information about the current process.","url":"https://d3codex.com/pickbasic-flashbasic/u2117-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u2117-user-exit.json"},{"slug":"pickbasic-flashbasic/u21a3-user-exit","title":"u21a3 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u21a3 user exit opens a file, or reads the next attribute from a file.","url":"https://d3codex.com/pickbasic-flashbasic/u21a3-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u21a3-user-exit.json"},{"slug":"pickbasic-flashbasic/u21b6-user-exit","title":"u21b6 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u21b6 user exit returns a numeric value representative of the current unit setting defined by the TCL set-units, set-dozens, set-decimal, or set-thousands commands.","url":"https://d3codex.com/pickbasic-flashbasic/u21b6-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u21b6-user-exit.json"},{"slug":"pickbasic-flashbasic/u22-user-exit","title":"u22 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u22 user exit converts lower case to upper case.","url":"https://d3codex.com/pickbasic-flashbasic/u22-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u22-user-exit.json"},{"slug":"pickbasic-flashbasic/u222d-user-exit","title":"u222d user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u222d user exit retrieves the CC pointer item information from binary items.","url":"https://d3codex.com/pickbasic-flashbasic/u222d-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u222d-user-exit.json"},{"slug":"pickbasic-flashbasic/u28-user-exit","title":"u28 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u28 user exit returns the number of saves that have occurred since the last full restore.","url":"https://d3codex.com/pickbasic-flashbasic/u28-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u28-user-exit.json"},{"slug":"pickbasic-flashbasic/u3060-user-exit","title":"u3060 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u3060 user exit encrypts a character string. The result is always an 8-character hexadecimal string.","url":"https://d3codex.com/pickbasic-flashbasic/u3060-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u3060-user-exit.json"},{"slug":"pickbasic-flashbasic/u3079-user-exit","title":"u3079 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u3079 user exit returns the PCB FID of the current process, or returns the port number of the current process.","url":"https://d3codex.com/pickbasic-flashbasic/u3079-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u3079-user-exit.json"},{"slug":"pickbasic-flashbasic/u307a-user-exit","title":"u307a user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u307a user exit suspends processing until a specified time.","url":"https://d3codex.com/pickbasic-flashbasic/u307a-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u307a-user-exit.json"},{"slug":"pickbasic-flashbasic/u3090-user-exit","title":"u3090 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u3090 user exit aborts a FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/u3090-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u3090-user-exit.json"},{"slug":"pickbasic-flashbasic/u313c-user-exit","title":"u313c user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u313c user exit returns the diskette drive type and density selected.","url":"https://d3codex.com/pickbasic-flashbasic/u313c-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u313c-user-exit.json"},{"slug":"pickbasic-flashbasic/u352e-user-exit","title":"u352e user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u352e user exit retrieves statistical information about the use of buffers by the D3 monitor. This user exit is for internal usage only.","url":"https://d3codex.com/pickbasic-flashbasic/u352e-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u352e-user-exit.json"},{"slug":"pickbasic-flashbasic/u3b-user-exit","title":"u3b user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u3b user exit returns information about the port.","url":"https://d3codex.com/pickbasic-flashbasic/u3b-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u3b-user-exit.json"},{"slug":"pickbasic-flashbasic/u3f-user-exit","title":"u3f user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u3f user exit converts an ASCII hexadecimal-format string to binary, and sends it to the printer.","url":"https://d3codex.com/pickbasic-flashbasic/u3f-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u3f-user-exit.json"},{"slug":"pickbasic-flashbasic/u4070-user-exit","title":"u4070 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u4070 user exit directs all subsequent output to the terminal. This is the same as the BASIC printer off statement.","url":"https://d3codex.com/pickbasic-flashbasic/u4070-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u4070-user-exit.json"},{"slug":"pickbasic-flashbasic/u407a-user-exit","title":"u407a user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u407a user exit sets a port to sleep for a specified number of seconds. This is the same as the BASIC sleep statement.","url":"https://d3codex.com/pickbasic-flashbasic/u407a-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u407a-user-exit.json"},{"slug":"pickbasic-flashbasic/u4117-user-exit","title":"u4117 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u4117 user exit returns the PCB (Process Control Block) in hexadecimal for the current process.","url":"https://d3codex.com/pickbasic-flashbasic/u4117-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u4117-user-exit.json"},{"slug":"pickbasic-flashbasic/u413c-user-exit","title":"u413c user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u413c sets the format type to the given format media.","url":"https://d3codex.com/pickbasic-flashbasic/u413c-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u413c-user-exit.json"},{"slug":"pickbasic-flashbasic/u4209-user-exit","title":"u4209 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u4209 user exit parses the input into discrete words.","url":"https://d3codex.com/pickbasic-flashbasic/u4209-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u4209-user-exit.json"},{"slug":"pickbasic-flashbasic/u47-user-exit","title":"u47 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u47 user exit writes a string in ASCII or hexadecimal to a specific location in a frame.","url":"https://d3codex.com/pickbasic-flashbasic/u47-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u47-user-exit.json"},{"slug":"pickbasic-flashbasic/u48-user-exit","title":"u48 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u48 user exit reads a specific location of a frame and returns the content.","url":"https://d3codex.com/pickbasic-flashbasic/u48-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u48-user-exit.json"},{"slug":"pickbasic-flashbasic/u50bb-user-exit","title":"u50bb user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u50bb user exit returns the port number, user-ID, and current account for this process, just like the TCL who command.","url":"https://d3codex.com/pickbasic-flashbasic/u50bb-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u50bb-user-exit.json"},{"slug":"pickbasic-flashbasic/u5117-user-exit","title":"u5117 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u5117 user exit returns the PCB in hexadecimal for port 0.","url":"https://d3codex.com/pickbasic-flashbasic/u5117-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u5117-user-exit.json"},{"slug":"pickbasic-flashbasic/u5e-user-exit","title":"u5e user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u5e user exit clears the internal BASIC heading and footing so that subsequent heading and footing statements display properly at the top of the next page.","url":"https://d3codex.com/pickbasic-flashbasic/u5e-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u5e-user-exit.json"},{"slug":"pickbasic-flashbasic/u60ba-user-exit","title":"u60ba user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u60ba user exit flushes all memory to disk, and shuts down the D3 system.","url":"https://d3codex.com/pickbasic-flashbasic/u60ba-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u60ba-user-exit.json"},{"slug":"pickbasic-flashbasic/u60bb-user-exit","title":"u60bb user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u60bb user exit returns the user-ID and account name of the current process.","url":"https://d3codex.com/pickbasic-flashbasic/u60bb-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u60bb-user-exit.json"},{"slug":"pickbasic-flashbasic/u6193-user-exit","title":"u6193 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u6193 user exit removes all but the last three characters from the data passed from the variable.","url":"https://d3codex.com/pickbasic-flashbasic/u6193-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u6193-user-exit.json"},{"slug":"pickbasic-flashbasic/u63-user-exit","title":"u63 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u63 user exit sets/clears privilege bits.","url":"https://d3codex.com/pickbasic-flashbasic/u63-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u63-user-exit.json"},{"slug":"pickbasic-flashbasic/u65-user-exit","title":"u65 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0065 user exit returns the estimated number of items in the most recently referenced file.","url":"https://d3codex.com/pickbasic-flashbasic/u65-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u65-user-exit.json"},{"slug":"pickbasic-flashbasic/u6d-user-exit","title":"u6d user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u6d user exit sends shutdown message.","url":"https://d3codex.com/pickbasic-flashbasic/u6d-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u6d-user-exit.json"},{"slug":"pickbasic-flashbasic/u7000-user-exit","title":"u7000 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u7000 user exit returns the size of an item.","url":"https://d3codex.com/pickbasic-flashbasic/u7000-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u7000-user-exit.json"},{"slug":"pickbasic-flashbasic/u70ba-user-exit","title":"u70ba user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u70ba user exit forces the system to restart.","url":"https://d3codex.com/pickbasic-flashbasic/u70ba-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u70ba-user-exit.json"},{"slug":"pickbasic-flashbasic/u71-user-exit","title":"u71 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u71 user exit sets the HAForceCheck option programmatically. See the Host Authentication topic in the System Administration Guide for more information on host authentication.","url":"https://d3codex.com/pickbasic-flashbasic/u71-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u71-user-exit.json"},{"slug":"pickbasic-flashbasic/u7193-user-exit","title":"u7193 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u7193 user exit converts the American date format (mm/dd/yy) to international format (dd/mm/yy).","url":"https://d3codex.com/pickbasic-flashbasic/u7193-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u7193-user-exit.json"},{"slug":"pickbasic-flashbasic/u8194-user-exit","title":"u8194 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u8194 user exit returns the number of items selected by the most previous select.","url":"https://d3codex.com/pickbasic-flashbasic/u8194-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u8194-user-exit.json"},{"slug":"pickbasic-flashbasic/u83-user-exit","title":"u83 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u83 user exit sets a group lock.","url":"https://d3codex.com/pickbasic-flashbasic/u83-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u83-user-exit.json"},{"slug":"pickbasic-flashbasic/u84-user-exit","title":"u84 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u84 user exit clears a group lock from the group lock table.","url":"https://d3codex.com/pickbasic-flashbasic/u84-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u84-user-exit.json"},{"slug":"pickbasic-flashbasic/u86-user-exit","title":"u86 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u86 user exit sets the root fid of the index.","url":"https://d3codex.com/pickbasic-flashbasic/u86-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u86-user-exit.json"},{"slug":"pickbasic-flashbasic/u90-user-exit","title":"u90 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u90 user exit returns the file of files number for the file most previously referenced in the FlashBASIC or BASIC program.","url":"https://d3codex.com/pickbasic-flashbasic/u90-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u90-user-exit.json"},{"slug":"pickbasic-flashbasic/u90e3-user-exit","title":"u90e3 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u90e3 user exit flips the parity bit on the input.","url":"https://d3codex.com/pickbasic-flashbasic/u90e3-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u90e3-user-exit.json"},{"slug":"pickbasic-flashbasic/u91-user-exit","title":"u91 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u0091 user exit reads and writes D3 shell variables.","url":"https://d3codex.com/pickbasic-flashbasic/u91-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u91-user-exit.json"},{"slug":"pickbasic-flashbasic/u9116-user-exit","title":"u9116 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u9116 user exit logs on a given port.","url":"https://d3codex.com/pickbasic-flashbasic/u9116-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u9116-user-exit.json"},{"slug":"pickbasic-flashbasic/u92-user-exit","title":"u92 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u92 user exit follows the links of a frame.","url":"https://d3codex.com/pickbasic-flashbasic/u92-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u92-user-exit.json"},{"slug":"pickbasic-flashbasic/u98-user-exit","title":"u98 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The u98 user exit retrieves the links for the specified fid.","url":"https://d3codex.com/pickbasic-flashbasic/u98-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/u98-user-exit.json"},{"slug":"pickbasic-flashbasic/ua116-user-exit","title":"ua116 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ua116 user exit logs of the specified port.","url":"https://d3codex.com/pickbasic-flashbasic/ua116-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ua116-user-exit.json"},{"slug":"pickbasic-flashbasic/ub070-user-exit","title":"ub070 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ub070 user exit returns the absolute value of a variable, stripping the leading –, if any.","url":"https://d3codex.com/pickbasic-flashbasic/ub070-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ub070-user-exit.json"},{"slug":"pickbasic-flashbasic/ub0ba-user-exit","title":"ub0ba user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ub0ba user exit reads one string of memory. The string that is returned must be pre-allocated prior to running oconv.","url":"https://d3codex.com/pickbasic-flashbasic/ub0ba-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ub0ba-user-exit.json"},{"slug":"pickbasic-flashbasic/uc0ba-user-exit","title":"uc0ba user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uc0ba user exit writes a value into a memory address.","url":"https://d3codex.com/pickbasic-flashbasic/uc0ba-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uc0ba-user-exit.json"},{"slug":"pickbasic-flashbasic/uclose-command","title":"uclose command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uclose command closes a file variable previously opened with the uopen command.","url":"https://d3codex.com/pickbasic-flashbasic/uclose-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uclose-command.json"},{"slug":"pickbasic-flashbasic/ucreate-command","title":"ucreate command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ucreate command creates and opens a specified file on the host system.","url":"https://d3codex.com/pickbasic-flashbasic/ucreate-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ucreate-command.json"},{"slug":"pickbasic-flashbasic/ud0ba-user-exit","title":"ud0ba user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ud0ba user exit reads a character byte from a serial port.","url":"https://d3codex.com/pickbasic-flashbasic/ud0ba-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ud0ba-user-exit.json"},{"slug":"pickbasic-flashbasic/udelete-command","title":"udelete command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The udelete command removes the directory entry named by the path name.","url":"https://d3codex.com/pickbasic-flashbasic/udelete-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/udelete-command.json"},{"slug":"pickbasic-flashbasic/ue0ba-user-exit","title":"ue0ba user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ue0ba user exit writes a character byte out to a serial port.","url":"https://d3codex.com/pickbasic-flashbasic/ue0ba-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ue0ba-user-exit.json"},{"slug":"pickbasic-flashbasic/uerror-function","title":"uerror() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uerror() function returns the error number that resulted from the previous inter-operating system command.","url":"https://d3codex.com/pickbasic-flashbasic/uerror-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uerror-function.json"},{"slug":"pickbasic-flashbasic/uexecute-command","title":"uexecute command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uexecute command allows users to execute various Windows programs from within mvBASIC.","url":"https://d3codex.com/pickbasic-flashbasic/uexecute-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uexecute-command.json"},{"slug":"pickbasic-flashbasic/uf070-user-exit","title":"uf070 user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uf070 user exit starts and stops multiuser mode, and returns information about the number of serial ports, PIBs, phantom PIBs, licensed users, users logged on, and the maximum number of users that can log on.","url":"https://d3codex.com/pickbasic-flashbasic/uf070-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uf070-user-exit.json"},{"slug":"pickbasic-flashbasic/ulock-command","title":"ulock command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ulock command locks or unlocks a file specified by a file variable.","url":"https://d3codex.com/pickbasic-flashbasic/ulock-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ulock-command.json"},{"slug":"pickbasic-flashbasic/ulseek-function","title":"ulseek() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ulseek() function moves the file pointer in an open file and returns the position of the file pointer, which is the number of bytes from the beginning of the file.","url":"https://d3codex.com/pickbasic-flashbasic/ulseek-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ulseek-function.json"},{"slug":"pickbasic-flashbasic/umessage-command","title":"umessage command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The umessage command sends a Windows-style message to the Client linked to the process executing the command. If the optional TO clause is used, the umessage command sends a Windows application launched by the uexecute command.","url":"https://d3codex.com/pickbasic-flashbasic/umessage-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/umessage-command.json"},{"slug":"pickbasic-flashbasic/unassigned-function","title":"unassigned() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The unassigned() function indicates whether a variable has an assigned value.","url":"https://d3codex.com/pickbasic-flashbasic/unassigned-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/unassigned-function.json"},{"slug":"pickbasic-flashbasic/undefine-directive","title":"$UNDEFINE directive","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The $UNDEFINE directive deletes a specified identifier from the symbol table. The identifier must have previously been defined by a $DEFINE directive.","url":"https://d3codex.com/pickbasic-flashbasic/undefine-directive/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/undefine-directive.json"},{"slug":"pickbasic-flashbasic/unlock-statement","title":"unlock statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The unlock statement resets an execution lock, in the range 0 to 991, previously set with a lock statement.","url":"https://d3codex.com/pickbasic-flashbasic/unlock-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/unlock-statement.json"},{"slug":"pickbasic-flashbasic/until-clause","title":"until clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The until clause specifies a termination condition for a for...next or loop constructs.","url":"https://d3codex.com/pickbasic-flashbasic/until-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/until-clause.json"},{"slug":"pickbasic-flashbasic/uopen-command","title":"uopen command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uopen command opens a given file name to a file variable.","url":"https://d3codex.com/pickbasic-flashbasic/uopen-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uopen-command.json"},{"slug":"pickbasic-flashbasic/uread-command","title":"uread command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uread command reads data from a previously opened file on the host system.","url":"https://d3codex.com/pickbasic-flashbasic/uread-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uread-command.json"},{"slug":"pickbasic-flashbasic/ureadline-function","title":"ureadline() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The ureadline() function reads data from a previously opened file on the host system.","url":"https://d3codex.com/pickbasic-flashbasic/ureadline-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/ureadline-function.json"},{"slug":"pickbasic-flashbasic/using-the-com-interface-to-flashbasic","title":"Using the COM interface to FlashBASIC","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"This topic describes the COM interface to FlashBASIC. The objective is to allow a FlashBASIC module to act as an Automation Controller. This module can be a main, a trigger, or a rule module.","url":"https://d3codex.com/pickbasic-flashbasic/using-the-com-interface-to-flashbasic/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/using-the-com-interface-to-flashbasic.json"},{"slug":"pickbasic-flashbasic/usystem-function","title":"usystem() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The usystem() function is used to obtain information from the underlying operating system environment.","url":"https://d3codex.com/pickbasic-flashbasic/usystem-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/usystem-function.json"},{"slug":"pickbasic-flashbasic/uwaitfor-command","title":"uwaitfor command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uwaitfor command causes the process to wait until the Windows application, identified by the var variable, terminates or the time specified by the expr variable elapses.","url":"https://d3codex.com/pickbasic-flashbasic/uwaitfor-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uwaitfor-command.json"},{"slug":"pickbasic-flashbasic/uwrite-command","title":"uwrite command","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The uwrite command writes data to a previously opened file on the host system.","url":"https://d3codex.com/pickbasic-flashbasic/uwrite-command/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/uwrite-command.json"},{"slug":"pickbasic-flashbasic/value-count-expression","title":"Value count expression","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"A value count (vc) expression is an expression that evaluates to a valid value count.","url":"https://d3codex.com/pickbasic-flashbasic/value-count-expression/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/value-count-expression.json"},{"slug":"pickbasic-flashbasic/variables","title":"Variables","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"Variables store numbers, strings, file descriptors, or select lists and can change dynamically throughout the execution of the program.","url":"https://d3codex.com/pickbasic-flashbasic/variables/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/variables.json"},{"slug":"pickbasic-flashbasic/wakeup-statement","title":"wakeup statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The wakeup statement is used for BASIC programs to wake up a different process that is either sleeping or waiting for input at an INPUT statement (which has an associated ELSE clause).","url":"https://d3codex.com/pickbasic-flashbasic/wakeup-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/wakeup-statement.json"},{"slug":"pickbasic-flashbasic/weof-statement","title":"weof statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The weof statement writes an eof (end of file) mark to the currently attached magnetic media.","url":"https://d3codex.com/pickbasic-flashbasic/weof-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/weof-statement.json"},{"slug":"pickbasic-flashbasic/while-clause","title":"while clause","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The while clause specifies a continuation condition in a for...next or loop construct.","url":"https://d3codex.com/pickbasic-flashbasic/while-clause/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/while-clause.json"},{"slug":"pickbasic-flashbasic/write-statement","title":"write statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The write statement writes the item specified in dyn.array.var into the specified file, using the item-ID specified in the ID.exp.","url":"https://d3codex.com/pickbasic-flashbasic/write-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/write-statement.json"},{"slug":"pickbasic-flashbasic/writet-statement","title":"writet statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The writet statement writes a tape record to the attached magnetic media from the specified variable.","url":"https://d3codex.com/pickbasic-flashbasic/writet-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/writet-statement.json"},{"slug":"pickbasic-flashbasic/writetx-statement","title":"writetx statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The writetx statement writes a tape record, converts the string from ASCII hex to binary, and copies the string to the tape buffer.","url":"https://d3codex.com/pickbasic-flashbasic/writetx-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/writetx-statement.json"},{"slug":"pickbasic-flashbasic/writeu-statement","title":"writeu statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The writeu form of the write statement writes a dynamic array into the specified file variable and keeps items locked that were locked by a previous readu or readvu statement.","url":"https://d3codex.com/pickbasic-flashbasic/writeu-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/writeu-statement.json"},{"slug":"pickbasic-flashbasic/writev-statement","title":"writev statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The writev statement writes the value of an expression into the attribute designated in the attribute expression parameter, using the item-ID specified in ID.exp.","url":"https://d3codex.com/pickbasic-flashbasic/writev-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/writev-statement.json"},{"slug":"pickbasic-flashbasic/writevu-statement","title":"writevu statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The writevu form of this statement is identical to writev, except that it keeps items locked that were locked by a previous readu or readvu statement.","url":"https://d3codex.com/pickbasic-flashbasic/writevu-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/writevu-statement.json"},{"slug":"pickbasic-flashbasic/writex-statement","title":"writex statement","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The writex statement writes the item specified in dyn.array.var into the specified file, using the item-ID specified in the ID.exp. The writex statement will wait until the actual disk update takes place before continuing execution of the program. This is used for \"critical\" write-through, such as error-logging.","url":"https://d3codex.com/pickbasic-flashbasic/writex-statement/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/writex-statement.json"},{"slug":"pickbasic-flashbasic/xsuex-user-exit","title":"xsuex user exit","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The xsuex user exit obtains and manipulates external strings, allowing the caller (likely non-FlashBASIC) to store data without writing to a file or storing it in BASIC string space.","url":"https://d3codex.com/pickbasic-flashbasic/xsuex-user-exit/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/xsuex-user-exit.json"},{"slug":"pickbasic-flashbasic/xtd-function","title":"xtd() function","category":"PickBASIC / FlashBASIC","categorySlug":"pickbasic-flashbasic","summary":"The xtd() function converts an expression from its hexadecimal format into its equivalent decimal format.","url":"https://d3codex.com/pickbasic-flashbasic/xtd-function/","api":"https://d3codex.com/api/topics/pickbasic-flashbasic/xtd-function.json"},{"slug":"proc/a-command-proc-processor","title":"a command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The a command appends the string in the specified input buffer position to the currently active output buffer.","url":"https://d3codex.com/proc/a-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/a-command-proc-processor.json"},{"slug":"proc/b-command-proc-processor","title":"b command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The b command decrements (moves the pointer back) the currently active input buffer pointer by one ’word’ position.","url":"https://d3codex.com/proc/b-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/b-command-proc-processor.json"},{"slug":"proc/c-command-proc-processor","title":"c command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The c command indicates a remark command. All text that follows on the same line is ignored by the PROC interpreter.","url":"https://d3codex.com/proc/c-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/c-command-proc-processor.json"},{"slug":"proc/d-command-proc-processor","title":"d command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The d command displays either a specific position from the currently active input buffer, or all the positions.","url":"https://d3codex.com/proc/d-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/d-command-proc-processor.json"},{"slug":"proc/f-command-proc-processor","title":"f command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The f command increments (moves the pointer forward) the currently active input buffer pointer by 1. If the pointer is at the end of the buffer, this command has no effect.","url":"https://d3codex.com/proc/f-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/f-command-proc-processor.json"},{"slug":"proc/go-command","title":"go command","category":"PROC","categorySlug":"proc","summary":"The go command transfers program control to another Proc statement which starts with a statement label. The second form is an indirect transfer, according to the value of the label, as extracted from a parameter in the input buffer.","url":"https://d3codex.com/proc/go-command/","api":"https://d3codex.com/api/topics/proc/go-command.json"},{"slug":"proc/h-command","title":"h command","category":"PROC","categorySlug":"proc","summary":"The h command moves a literal string of characters to the currently active output buffer.","url":"https://d3codex.com/proc/h-command/","api":"https://d3codex.com/api/topics/proc/h-command.json"},{"slug":"proc/if-command","title":"if command","category":"PROC","categorySlug":"proc","summary":"The if command performs a conditional expression.","url":"https://d3codex.com/proc/if-command/","api":"https://d3codex.com/api/topics/proc/if-command.json"},{"slug":"proc/ih-command","title":"ih command","category":"PROC","categorySlug":"proc","summary":"The ih command removes the current parameter from the currently active input buffer and replaces it with a null value or the specified string.","url":"https://d3codex.com/proc/ih-command/","api":"https://d3codex.com/api/topics/proc/ih-command.json"},{"slug":"proc/in-command","title":"in command","category":"PROC","categorySlug":"proc","summary":"The in command prompts for input from the terminal and places it in the secondary input buffer. Contents of the secondary input buffer are destroyed and the buffer pointer is set to the beginning, prior to placing data in the buffer. Leading and trailing blanks are removed and embedded blanks are replaced with a single attribute mark.","url":"https://d3codex.com/proc/in-command/","api":"https://d3codex.com/api/topics/proc/in-command.json"},{"slug":"proc/ip-command","title":"ip command","category":"PROC","categorySlug":"proc","summary":"The ip command stops execution of the Proc and awaits a response from the keyboard.","url":"https://d3codex.com/proc/ip-command/","api":"https://d3codex.com/api/topics/proc/ip-command.json"},{"slug":"proc/is-command","title":"is command","category":"PROC","categorySlug":"proc","summary":"The is command temporarily stops execution of the Proc until a response is provided from the keyboard. Input is placed into the secondary input buffer. Any existing data at that location is overwritten. If the pointer is already at the end of the buffer, the input is appended to the end. The colon is the default prompt character.","url":"https://d3codex.com/proc/is-command/","api":"https://d3codex.com/api/topics/proc/is-command.json"},{"slug":"proc/it-command","title":"it command","category":"PROC","categorySlug":"proc","summary":"The it command inputs data from the tape label of the currently attached magnetic media directly into the primary input buffer. The input buffer is cleared before the label is copied into it. If there is no label, the input buffer is cleared anyway. Note that the tape device must be attached.","url":"https://d3codex.com/proc/it-command/","api":"https://d3codex.com/api/topics/proc/it-command.json"},{"slug":"proc/linkages","title":"Linkages","category":"PROC","categorySlug":"proc","summary":"Linkages are the means by which Procs either pass control one way to another Proc, or call another Proc as an external subroutine. The type of linkage is determined by the character used in the syntax. For example:","url":"https://d3codex.com/proc/linkages/","api":"https://d3codex.com/api/topics/proc/linkages.json"},{"slug":"proc/logon-procs-and-macros","title":"Logon procs and macros","category":"PROC","categorySlug":"proc","summary":"Logon Procs or macros automatically execute at log on. After the user has provided a valid account name and optionally the password, the master dictionary of the designated account is checked for a Proc or macro with the same name as the account. If it exists, it starts up automatically. If no such Proc or macro exists, control is transferred to TCL. In D3, the user-macro may also be used for personalized logon sequences.","url":"https://d3codex.com/proc/logon-procs-and-macros/","api":"https://d3codex.com/api/topics/proc/logon-procs-and-macros.json"},{"slug":"proc/minus-command","title":"- command","category":"PROC","categorySlug":"proc","summary":"The - command subtracts the specified integer number from the current value of the currently active input buffer.","url":"https://d3codex.com/proc/minus-command/","api":"https://d3codex.com/api/topics/proc/minus-command.json"},{"slug":"proc/o-command-proc-processor","title":"o command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The o command outputs literal text to the terminal at the next available line.","url":"https://d3codex.com/proc/o-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/o-command-proc-processor.json"},{"slug":"proc/p-command-proc-processor","title":"p command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The p command processes the commands in the currently active output buffers. The primary output buffer is processed first, followed by the secondary output buffer. Both the primary and secondary output buffers are automatically reset after the p command, and the active buffer pointer is reset to point to the primary output buffer.","url":"https://d3codex.com/proc/p-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/p-command-proc-processor.json"},{"slug":"proc/plus-command","title":"+ command","category":"PROC","categorySlug":"proc","summary":"The + command adds the specified integer number to the current value of the currently active input buffer.","url":"https://d3codex.com/proc/plus-command/","api":"https://d3codex.com/api/topics/proc/plus-command.json"},{"slug":"proc/pq-dictionary-code","title":"pq dictionary code","category":"PROC","categorySlug":"proc","summary":"The pq code is a processing code in a master dictionary item defining itself as a Proc. It is required as the first line of every Proc.","url":"https://d3codex.com/proc/pq-dictionary-code/","api":"https://d3codex.com/api/topics/proc/pq-dictionary-code.json"},{"slug":"proc/proc-buffers","title":"PROC buffers","category":"PROC","categorySlug":"proc","summary":"The main operation of a Proc is to move data from one of the two input buffers into one of the two output buffers to perform the desired TCL commands.","url":"https://d3codex.com/proc/proc-buffers/","api":"https://d3codex.com/api/topics/proc/proc-buffers.json"},{"slug":"proc/proc-processor","title":"PROC processor","category":"PROC","categorySlug":"proc","summary":"This section discusses the PROC processor.","url":"https://d3codex.com/proc/proc-processor/","api":"https://d3codex.com/api/topics/proc/proc-processor.json"},{"slug":"proc/proc-processor-commands","title":"PROC processor commands","category":"PROC","categorySlug":"proc","summary":"The following PROC processor commands are available.","url":"https://d3codex.com/proc/proc-processor-commands/","api":"https://d3codex.com/api/topics/proc/proc-processor-commands.json"},{"slug":"proc/proc-processor-overview","title":"PROC processor overview","category":"PROC","categorySlug":"proc","summary":"PROC, short for procedure, allows executing a series of TCL and other commands from a single word command. Everything that can be done in TCL can be done in PROC. Procs also are used to avoid repetitively typing the same series of commands, to interact with the user, and to test or verify input information from the user.","url":"https://d3codex.com/proc/proc-processor-overview/","api":"https://d3codex.com/api/topics/proc/proc-processor-overview.json"},{"slug":"proc/proc-processor-user-exits","title":"PROC processor user exits","category":"PROC","categorySlug":"proc","summary":"User exits allow direct access to system functions.","url":"https://d3codex.com/proc/proc-processor-user-exits/","api":"https://d3codex.com/api/topics/proc/proc-processor-user-exits.json"},{"slug":"proc/ri-command","title":"ri command","category":"PROC","categorySlug":"proc","summary":"The ri command resets either the entire Proc input buffer, or all of the locations following a specified location, and resets both input buffers to null.","url":"https://d3codex.com/proc/ri-command/","api":"https://d3codex.com/api/topics/proc/ri-command.json"},{"slug":"proc/ro-command","title":"ro command","category":"PROC","categorySlug":"proc","summary":"The ro command resets both of the output buffers. There is rarely a case where this is ever required.","url":"https://d3codex.com/proc/ro-command/","api":"https://d3codex.com/api/topics/proc/ro-command.json"},{"slug":"proc/s-command-proc-processor","title":"s command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The s command sets the input pointer to a specified position number, activating the specified parameter number as the currently active input buffer location.","url":"https://d3codex.com/proc/s-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/s-command-proc-processor.json"},{"slug":"proc/sp-command","title":"sp command","category":"PROC","categorySlug":"proc","summary":"The sp command selects the primary input buffer, and positions the pointer to the beginning of the input buffer.","url":"https://d3codex.com/proc/sp-command/","api":"https://d3codex.com/api/topics/proc/sp-command.json"},{"slug":"proc/ss-command","title":"ss command","category":"PROC","categorySlug":"proc","summary":"The ss command selects the secondary input buffer and positions the pointer to the beginning of the secondary input buffer.","url":"https://d3codex.com/proc/ss-command/","api":"https://d3codex.com/api/topics/proc/ss-command.json"},{"slug":"proc/st-command","title":"st command","category":"PROC","categorySlug":"proc","summary":"The st command selects and directs output either to the primary output buffer (turns off the stack) or to the secondary output buffer (turns on the stack). When the stack is off, all data picked up by the a command is put in the primary output buffer. When the stack is on, the data is put in the secondary output buffer.","url":"https://d3codex.com/proc/st-command/","api":"https://d3codex.com/api/topics/proc/st-command.json"},{"slug":"proc/t-command-proc-processor","title":"t command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The t command directs output to the terminal screen and controls special terminal display functions.","url":"https://d3codex.com/proc/t-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/t-command-proc-processor.json"},{"slug":"proc/u0032-user-exit","title":"u0032 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u0032 logs off the current process.","url":"https://d3codex.com/proc/u0032-user-exit/","api":"https://d3codex.com/api/topics/proc/u0032-user-exit.json"},{"slug":"proc/u0070-user-exit","title":"u0070 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u0070 performs a correlated match on a MultiValue set.","url":"https://d3codex.com/proc/u0070-user-exit/","api":"https://d3codex.com/api/topics/proc/u0070-user-exit.json"},{"slug":"proc/u0191-user-exit","title":"u0191 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u0191 sets system execution lock number 9. If the lock takes place successfully, the next physical line of the Proc is skipped. When it does not lock successfully, the line immediately following the user exit is performed.","url":"https://d3codex.com/proc/u0191-user-exit/","api":"https://d3codex.com/api/topics/proc/u0191-user-exit.json"},{"slug":"proc/u0192-user-exit","title":"u0192 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u0192 is for general output formatting. Output values can be literals, attribute values, or converted attribute values.","url":"https://d3codex.com/proc/u0192-user-exit/","api":"https://d3codex.com/api/topics/proc/u0192-user-exit.json"},{"slug":"proc/u0193-user-exit","title":"u0193 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u0193 moves a parameter from the source buffer to the destination buffer.","url":"https://d3codex.com/proc/u0193-user-exit/","api":"https://d3codex.com/api/topics/proc/u0193-user-exit.json"},{"slug":"proc/u0195-user-exit","title":"u0195 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u0195 saves an active list. The address of the currently active lists, the pointer to the next item to be accessed from the list, and the base/modulo of the file are saved in a special workspace. Once the list has been saved, it may be accessed via the u1195 user exit.","url":"https://d3codex.com/proc/u0195-user-exit/","api":"https://d3codex.com/api/topics/proc/u0195-user-exit.json"},{"slug":"proc/u01a2-user-exit","title":"u01a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u01a2 executes a computed goto branch based on the value in the current output buffer.","url":"https://d3codex.com/proc/u01a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u01a2-user-exit.json"},{"slug":"proc/u01a6-user-exit","title":"u01a6 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u01a6 performs cursor control functions. Nearly all the functionality of this user exit is available through the t PROC command, which should be preferred to this user exit.","url":"https://d3codex.com/proc/u01a6-user-exit/","api":"https://d3codex.com/api/topics/proc/u01a6-user-exit.json"},{"slug":"proc/u01ad-user-exit","title":"u01ad user exit","category":"PROC","categorySlug":"proc","summary":"User exit u01ad retrieves a value from an attribute of an item in a file. The next line of the Proc specifies the file information.","url":"https://d3codex.com/proc/u01ad-user-exit/","api":"https://d3codex.com/api/topics/proc/u01ad-user-exit.json"},{"slug":"proc/u01b8-user-exit","title":"u01b8 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u01b8 returns and (optionally) formats a value from a file or a text string.","url":"https://d3codex.com/proc/u01b8-user-exit/","api":"https://d3codex.com/api/topics/proc/u01b8-user-exit.json"},{"slug":"proc/u1191-user-exit","title":"u1191 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u1191 releases previously-locked execution lock number 9. This lock typically would have been set by a call to user exit u0191. If the execution lock was locked by some other port number, then it will not be unlocked.","url":"https://d3codex.com/proc/u1191-user-exit/","api":"https://d3codex.com/api/topics/proc/u1191-user-exit.json"},{"slug":"proc/u1193-user-exit","title":"u1193 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u1193 swaps the first two values of the date. This allows for conversions of European date displays to American date displays or vice-versa.","url":"https://d3codex.com/proc/u1193-user-exit/","api":"https://d3codex.com/api/topics/proc/u1193-user-exit.json"},{"slug":"proc/u1195-user-exit","title":"u1195 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u1195 retrieves the next item in an active list.","url":"https://d3codex.com/proc/u1195-user-exit/","api":"https://d3codex.com/api/topics/proc/u1195-user-exit.json"},{"slug":"proc/u11a2-user-exit","title":"u11a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u11a2 pads the current input buffer with enough leading zeros to make the value in the number of digits a specific number of digits wide, and returns the resulting string to the secondary input buffer.","url":"https://d3codex.com/proc/u11a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u11a2-user-exit.json"},{"slug":"proc/u11ad-user-exit","title":"u11ad user exit","category":"PROC","categorySlug":"proc","summary":"User exit u11ad retrieves all MultiValue from an attribute. The following line of the Proc specifies the file information, and a code number.","url":"https://d3codex.com/proc/u11ad-user-exit/","api":"https://d3codex.com/api/topics/proc/u11ad-user-exit.json"},{"slug":"proc/u11bc-user-exit","title":"u11bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit u11bc pads the value in the secondary input buffer with zeros.","url":"https://d3codex.com/proc/u11bc-user-exit/","api":"https://d3codex.com/api/topics/proc/u11bc-user-exit.json"},{"slug":"proc/u20d7-user-exit","title":"u20d7 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u20d7 initiates a restore of the entire file system from file-save media.","url":"https://d3codex.com/proc/u20d7-user-exit/","api":"https://d3codex.com/api/topics/proc/u20d7-user-exit.json"},{"slug":"proc/u218d-user-exit","title":"u218d user exit","category":"PROC","categorySlug":"proc","summary":"User exit u218d disables the BREAK key.","url":"https://d3codex.com/proc/u218d-user-exit/","api":"https://d3codex.com/api/topics/proc/u218d-user-exit.json"},{"slug":"proc/u2191-user-exit","title":"u2191 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u2191 unconditionally releases execution lock number 9. This execution lock is typically set with user exit u0191.","url":"https://d3codex.com/proc/u2191-user-exit/","api":"https://d3codex.com/api/topics/proc/u2191-user-exit.json"},{"slug":"proc/u2193-user-exit","title":"u2193 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u2193 sets the current position of the assigned print queue as top-of-form for subsequent printer output.","url":"https://d3codex.com/proc/u2193-user-exit/","api":"https://d3codex.com/api/topics/proc/u2193-user-exit.json"},{"slug":"proc/u219b-user-exit","title":"u219b user exit","category":"PROC","categorySlug":"proc","summary":"User exit u219b kills the Proc stack flag.","url":"https://d3codex.com/proc/u219b-user-exit/","api":"https://d3codex.com/api/topics/proc/u219b-user-exit.json"},{"slug":"proc/u21a2-user-exit","title":"u21a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u21a2 resets both output buffers, just like the ro command.","url":"https://d3codex.com/proc/u21a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u21a2-user-exit.json"},{"slug":"proc/u21ad-user-exit","title":"u21ad user exit","category":"PROC","categorySlug":"proc","summary":"User exit u21ad retrieves all values of an attribute from an item in a file, but does not advance the MultiValue counter. The following line of the Proc specifies the file information, and a code number.","url":"https://d3codex.com/proc/u21ad-user-exit/","api":"https://d3codex.com/api/topics/proc/u21ad-user-exit.json"},{"slug":"proc/u21bc-user-exit","title":"u21bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit u21bc deletes entries from the output buffer. The next line in the Proc specifies the delete code.","url":"https://d3codex.com/proc/u21bc-user-exit/","api":"https://d3codex.com/api/topics/proc/u21bc-user-exit.json"},{"slug":"proc/u318d-user-exit","title":"u318d user exit","category":"PROC","categorySlug":"proc","summary":"User exit u318d enables the BREAK key.","url":"https://d3codex.com/proc/u318d-user-exit/","api":"https://d3codex.com/api/topics/proc/u318d-user-exit.json"},{"slug":"proc/u3191-user-exit","title":"u3191 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u3191 releases an execution lock if it was locked by the current port. This user exit performs the same function as the u1191 user exit with the exception that no error path is taken if execute lock is locked by another process.","url":"https://d3codex.com/proc/u3191-user-exit/","api":"https://d3codex.com/api/topics/proc/u3191-user-exit.json"},{"slug":"proc/u3193-user-exit","title":"u3193 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u3193 directs all subsequent output to the terminal.","url":"https://d3codex.com/proc/u3193-user-exit/","api":"https://d3codex.com/api/topics/proc/u3193-user-exit.json"},{"slug":"proc/u31a2-user-exit","title":"u31a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u31a2 flags a statement for later transfer of control.","url":"https://d3codex.com/proc/u31a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u31a2-user-exit.json"},{"slug":"proc/u31ad-user-exit","title":"u31ad user exit","category":"PROC","categorySlug":"proc","summary":"User exit u31ad returns the current port number.","url":"https://d3codex.com/proc/u31ad-user-exit/","api":"https://d3codex.com/api/topics/proc/u31ad-user-exit.json"},{"slug":"proc/u31bc-user-exit","title":"u31bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit u31bc implements a Proc subroutine call.","url":"https://d3codex.com/proc/u31bc-user-exit/","api":"https://d3codex.com/api/topics/proc/u31bc-user-exit.json"},{"slug":"proc/u401c-user-exit","title":"u401c user exit","category":"PROC","categorySlug":"proc","summary":"User exit u401c returns the current ABS frame number.","url":"https://d3codex.com/proc/u401c-user-exit/","api":"https://d3codex.com/api/topics/proc/u401c-user-exit.json"},{"slug":"proc/u4193-user-exit","title":"u4193 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u4193 disables output to the Spooler, and redirects output to the terminal. Called from PROC, this performs the exact same process as printer close in FlashBASIC. Its function is to close the currently open print job and direct subsequent output to the terminal.","url":"https://d3codex.com/proc/u4193-user-exit/","api":"https://d3codex.com/api/topics/proc/u4193-user-exit.json"},{"slug":"proc/u419b-user-exit","title":"u419b user exit","category":"PROC","categorySlug":"proc","summary":"User exit u419b returns the number of AQL items selected into a Proc parameter.","url":"https://d3codex.com/proc/u419b-user-exit/","api":"https://d3codex.com/api/topics/proc/u419b-user-exit.json"},{"slug":"proc/u41a2-user-exit","title":"u41a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u41a2 returns control to the statement immediately following the most recently executed subroutine call.","url":"https://d3codex.com/proc/u41a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u41a2-user-exit.json"},{"slug":"proc/u41ad-user-exit","title":"u41ad user exit","category":"PROC","categorySlug":"proc","summary":"User exit u41ad replaces the string in the primary input buffer with a new string, placed in the next Proc line.","url":"https://d3codex.com/proc/u41ad-user-exit/","api":"https://d3codex.com/api/topics/proc/u41ad-user-exit.json"},{"slug":"proc/u41bc-user-exit","title":"u41bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit u41bc is a Proc subroutine return.","url":"https://d3codex.com/proc/u41bc-user-exit/","api":"https://d3codex.com/api/topics/proc/u41bc-user-exit.json"},{"slug":"proc/u5193-user-exit","title":"u5193 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u5193 sends the bell character (beep) to the terminal.","url":"https://d3codex.com/proc/u5193-user-exit/","api":"https://d3codex.com/api/topics/proc/u5193-user-exit.json"},{"slug":"proc/u51bc-user-exit","title":"u51bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit u51bc is a Proc subroutine return.","url":"https://d3codex.com/proc/u51bc-user-exit/","api":"https://d3codex.com/api/topics/proc/u51bc-user-exit.json"},{"slug":"proc/u61a2-user-exit","title":"u61a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u61a2 toggles a system-level flag that controls visible output to the users terminal. When terminal output is suppressed, this is equivalent to the ph PROC command. The reverse of this operation would be the u3193 user exit that sets terminal output on regardless of its current setting.","url":"https://d3codex.com/proc/u61a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u61a2-user-exit.json"},{"slug":"proc/u61bc-user-exit","title":"u61bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit u61bc disables terminal output. This is the reverse of the u3193 user exit and is the equivalent of the ph PROC command.","url":"https://d3codex.com/proc/u61bc-user-exit/","api":"https://d3codex.com/api/topics/proc/u61bc-user-exit.json"},{"slug":"proc/u713c-user-exit","title":"u713c user exit","category":"PROC","categorySlug":"proc","summary":"User exit u713c returns the system serial number.","url":"https://d3codex.com/proc/u713c-user-exit/","api":"https://d3codex.com/api/topics/proc/u713c-user-exit.json"},{"slug":"proc/u71a2-user-exit","title":"u71a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u71a2 returns the port number of the current process, and places it in the output buffer.","url":"https://d3codex.com/proc/u71a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u71a2-user-exit.json"},{"slug":"proc/u8193-user-exit","title":"u8193 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u8193 directs all subsequent output to the printer.","url":"https://d3codex.com/proc/u8193-user-exit/","api":"https://d3codex.com/api/topics/proc/u8193-user-exit.json"},{"slug":"proc/u91a2-user-exit","title":"u91a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit u91a2 transfers control to the specified Proc name in the primary output buffer. The primary input buffer is unaffected. Both output buffers are cleared.","url":"https://d3codex.com/proc/u91a2-user-exit/","api":"https://d3codex.com/api/topics/proc/u91a2-user-exit.json"},{"slug":"proc/u91bc-user-exit","title":"u91bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit u91bc transfers control (chains) to another Proc, without affecting the contents of the input buffers. The target Proc name is listed on the line above the user exit.","url":"https://d3codex.com/proc/u91bc-user-exit/","api":"https://d3codex.com/api/topics/proc/u91bc-user-exit.json"},{"slug":"proc/ua1a2-user-exit","title":"ua1a2 user exit","category":"PROC","categorySlug":"proc","summary":"User exit ua1a2 deletes the data in the primary input buffer from the current pointer to the end of the buffer.","url":"https://d3codex.com/proc/ua1a2-user-exit/","api":"https://d3codex.com/api/topics/proc/ua1a2-user-exit.json"},{"slug":"proc/ua1bc-user-exit","title":"ua1bc user exit","category":"PROC","categorySlug":"proc","summary":"User exit ua1bc moves entries from the current position in the input buffer to the end.","url":"https://d3codex.com/proc/ua1bc-user-exit/","api":"https://d3codex.com/api/topics/proc/ua1bc-user-exit.json"},{"slug":"proc/ud070-user-exit","title":"ud070 user exit","category":"PROC","categorySlug":"proc","summary":"User exit ud070 returns the who information for the current process into the active input buffer. If charge-to is active, the account name is not included.","url":"https://d3codex.com/proc/ud070-user-exit/","api":"https://d3codex.com/api/topics/proc/ud070-user-exit.json"},{"slug":"proc/ue070-user-exit","title":"ue070 user exit","category":"PROC","categorySlug":"proc","summary":"User exit ue070 returns the current tape reel number into the active input buffer.","url":"https://d3codex.com/proc/ue070-user-exit/","api":"https://d3codex.com/api/topics/proc/ue070-user-exit.json"},{"slug":"proc/x-command-proc-processor","title":"x command (PROC processor)","category":"PROC","categorySlug":"proc","summary":"The x command serves two purposes:","url":"https://d3codex.com/proc/x-command-proc-processor/","api":"https://d3codex.com/api/topics/proc/x-command-proc-processor.json"},{"slug":"processingcodes/a-algebraic-processing-code","title":"a (algebraic) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The a processing code is a recursive algebraic function that creates algebraic formulas and relational operations consisting of operands and operators; these expressions are used by AQL as well as the B-tree indexes. The a processing codes are translated into f processing codes by the AQL compiler. The functional operators and operands for the a processing code are the same as that of the f processing code, except as noted.","url":"https://d3codex.com/processingcodes/a-algebraic-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/a-algebraic-processing-code.json"},{"slug":"processingcodes/b-bridge-processing-code","title":"b (bridge) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The b processing code maintains a horizontal relationship (bridge) between an attribute in one item and an item in another file (or the same file) on the system level.","url":"https://d3codex.com/processingcodes/b-bridge-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/b-bridge-processing-code.json"},{"slug":"processingcodes/c-concatenate-processing-code","title":"c (Concatenate) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The c processing code concatenates elements for output.","url":"https://d3codex.com/processingcodes/c-concatenate-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/c-concatenate-processing-code.json"},{"slug":"processingcodes/c-controlling-processing-code","title":"c (controlling) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The c processing code defines the controlling attribute in a controlling/dependent pair of attributes when placed in attribute 4 of the ADI.","url":"https://d3codex.com/processingcodes/c-controlling-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/c-controlling-processing-code.json"},{"slug":"processingcodes/call-processing-code","title":"call processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The call processing code calls a BASIC or FlashBASIC subroutine from the file-defining item or an ADI. Called subroutines are Flash compiled to improve performance.","url":"https://d3codex.com/processingcodes/call-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/call-processing-code.json"},{"slug":"processingcodes/callc-close-trigger-processing-code","title":"callc (close trigger) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The callc (close trigger) is called before the table is closed.","url":"https://d3codex.com/processingcodes/callc-close-trigger-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/callc-close-trigger-processing-code.json"},{"slug":"processingcodes/calld-delete-trigger-processing-code","title":"calld (Delete Trigger) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The calld (delete file trigger) is called before the file is deleted.","url":"https://d3codex.com/processingcodes/calld-delete-trigger-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/calld-delete-trigger-processing-code.json"},{"slug":"processingcodes/calle-clear-trigger-processing-code","title":"calle (clear trigger) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The calle (clear file trigger) is called before the file is cleared.","url":"https://d3codex.com/processingcodes/calle-clear-trigger-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/calle-clear-trigger-processing-code.json"},{"slug":"processingcodes/callo-open-trigger-processing-code","title":"callo (open trigger) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"For Windows (FSI): The callo (open trigger) is called after a table has successfully been opened.","url":"https://d3codex.com/processingcodes/callo-open-trigger-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/callo-open-trigger-processing-code.json"},{"slug":"processingcodes/callr-read-trigger-processing-code","title":"callr (Read Trigger) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The callr (read trigger) is called when a record is read from the table.","url":"https://d3codex.com/processingcodes/callr-read-trigger-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/callr-read-trigger-processing-code.json"},{"slug":"processingcodes/callx-write-trigger-processing-code","title":"callx (write trigger) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The callx processing code is called when a record is updated in the table.","url":"https://d3codex.com/processingcodes/callx-write-trigger-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/callx-write-trigger-processing-code.json"},{"slug":"processingcodes/cu-character-update-processing-code","title":"cu (character update) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The cu processing code allows data in a defined attribute with an output-conversion (attribute 7) or correlative (attribute 8) to be changed character by character with the Update processor. The cu processing code is placed in the input-conversion (attribute 14). If cu is not specified, existing data is erased and nulled when editing is started.","url":"https://d3codex.com/processingcodes/cu-character-update-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/cu-character-update-processing-code.json"},{"slug":"processingcodes/d-date-processing-code","title":"d (date) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The d processing code invokes the date conversion function to convert an external date to internal format, or more commonly, to convert an internal date to one of many available output formats.","url":"https://d3codex.com/processingcodes/d-date-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/d-date-processing-code.json"},{"slug":"processingcodes/d-dependent-value-processing-code","title":"d (dependent value) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The d processing code defines the dependent attribute in a control/dependent pair of correlated MultiValues; the controlling attribute must contain a c code. The attribute count specified in the attribute count parameter must contain the c code and attribute count of the controlling attribute. Note that this function belongs in attribute 4 of the item.","url":"https://d3codex.com/processingcodes/d-dependent-value-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/d-dependent-value-processing-code.json"},{"slug":"processingcodes/encrypt-processing-code","title":"encrypt processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The encrypt processing code is field-level encryption functionality that works with the encrypt-file and decrypt-file commands.","url":"https://d3codex.com/processingcodes/encrypt-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/encrypt-processing-code.json"},{"slug":"processingcodes/f-f-correlative-processing-code","title":"f (f-correlative) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The f-correlative is used in the conversion (attribute 7), correlative (attribute 8), and input-conversion (attribute 14) attributes of attribute-defining items to create and modify the associated attribute value using various mathematical and logical operations.","url":"https://d3codex.com/processingcodes/f-f-correlative-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/f-f-correlative-processing-code.json"},{"slug":"processingcodes/g-group-extract-processing-code","title":"g (group extract) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The g processing code extracts one or more groups of contiguous character substrings delimited by the specified character.","url":"https://d3codex.com/processingcodes/g-group-extract-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/g-group-extract-processing-code.json"},{"slug":"processingcodes/i-index-processing-code","title":"i (index) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The i processing code is stored in the correlative (attribute 8) of the file-defining items to maintain index keys. The root FID (VME only) is inserted by the system and must not be altered.","url":"https://d3codex.com/processingcodes/i-index-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/i-index-processing-code.json"},{"slug":"processingcodes/i-local-index-processing-code","title":"i (local index) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The i processing code indicates that an index exists for the current attribute. It must be defined in the attribute-defining item that corresponds to a local B-tree index previously created with a create-index command.","url":"https://d3codex.com/processingcodes/i-local-index-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/i-local-index-processing-code.json"},{"slug":"processingcodes/i-remote-index-processing-code","title":"i (remote index) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The i processing code is used as an input-conversion (attribute 14) and indicates that this attribute is based on data indexed in another file. When editing data in this attribute, the user can cruise both forward and backward through the index in the specified secondary file.","url":"https://d3codex.com/processingcodes/i-remote-index-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/i-remote-index-processing-code.json"},{"slug":"processingcodes/id-item-id-processing-code","title":"id (item ID) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The id processing code is used by the Update processor to create new item-IDs. Originally implemented for the Update Processor, it was later implemented for all write operations within the D3 Windows FSI to facilitate transaction enqueuing for FSI Hot Backup.","url":"https://d3codex.com/processingcodes/id-item-id-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/id-item-id-processing-code.json"},{"slug":"processingcodes/if-if-then-processing-code","title":"if (if/then) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The if processing code is used in dictionary attributes 7 and 8 (conversion and correlative) to generate values based on results of evaluation of expression according to the rules of a-correlative construction.","url":"https://d3codex.com/processingcodes/if-if-then-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/if-if-then-processing-code.json"},{"slug":"processingcodes/l-length-processing-code","title":"l (length) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The l processing code either restricts processing to values that fall within certain length restrictions or displays the length of a given value.","url":"https://d3codex.com/processingcodes/l-length-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/l-length-processing-code.json"},{"slug":"processingcodes/m-mask-processing-code","title":"m (mask) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The m processing code is a masking conversion used for both numeric and text string formatting. This conversion is quite complex because nearly all of the elements available in its syntax are optional. The elements are listed in the order that the system evaluates the expression. If an element is going to be used, it must be in the same order shown. Each of the elements available is discussed.","url":"https://d3codex.com/processingcodes/m-mask-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/m-mask-processing-code.json"},{"slug":"processingcodes/mc-mask-character-processing-code","title":"mc (mask character) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The mc processing code invokes one of many available processing codes available for special processing on numeric and alphabetic strings of characters. Multiple mc conversions may be placed on the same attribute in an attribute-defining item, provided that each is delimited by a value mark.","url":"https://d3codex.com/processingcodes/mc-mask-character-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/mc-mask-character-processing-code.json"},{"slug":"processingcodes/mi-must-input-processing-code","title":"mi (must input) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The mi processing code is used as an input-conversion code (attribute 14) and prohibits filing an item if any attribute defined with an mi code is null.","url":"https://d3codex.com/processingcodes/mi-must-input-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/mi-must-input-processing-code.json"},{"slug":"processingcodes/mp-mask-packed-decimal-processing-code","title":"mp (mask packed decimal) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The mp processing code is used for converting a value to a packed decimal value or a packed decimal value to a value.","url":"https://d3codex.com/processingcodes/mp-mask-packed-decimal-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/mp-mask-packed-decimal-processing-code.json"},{"slug":"processingcodes/ms-mask-alter-sort-processing-code","title":"ms (mask alter sort) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The ms processing code alters the normal sort sequence of characters.","url":"https://d3codex.com/processingcodes/ms-mask-alter-sort-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/ms-mask-alter-sort-processing-code.json"},{"slug":"processingcodes/mt-mask-time-processing-code","title":"mt (mask time) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The mt processing code invokes the time conversion function to convert external time representations to internal format or to convert internal time values to one of a variety of external time formats.","url":"https://d3codex.com/processingcodes/mt-mask-time-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/mt-mask-time-processing-code.json"},{"slug":"processingcodes/mx-mask-ascii-to-hexadecimal-processing-code","title":"mx (mask ASCII to hexadecimal) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The mx processing code converts all ASCII characters in a given value to their corresponding ASCII-hexadecimal equivalent. The characters are converted one at a time to 2-digit hexadecimal numbers. The my code is the inverse of the mx code.","url":"https://d3codex.com/processingcodes/mx-mask-ascii-to-hexadecimal-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/mx-mask-ascii-to-hexadecimal-processing-code.json"},{"slug":"processingcodes/my-mask-hexadecimal-to-ascii-processing-code","title":"my (mask hexadecimal to ASCII) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The my processing code converts all ASCII hexadecimal characters in a given value to their corresponding ASCII equivalent. The characters are converted two at a time to 1-digit ASCII characters. The mx code is the inverse of the my code.","url":"https://d3codex.com/processingcodes/my-mask-hexadecimal-to-ascii-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/my-mask-hexadecimal-to-ascii-processing-code.json"},{"slug":"processingcodes/o-sort-values-ascending-processing-code","title":"o (sort values ascending) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The o processing code sorts the values in the specified attributes in ascending order. The values are sorted when the item is filed.","url":"https://d3codex.com/processingcodes/o-sort-values-ascending-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/o-sort-values-ascending-processing-code.json"},{"slug":"processingcodes/p-pattern-match-processing-code","title":"p (pattern match) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The p processing code tests a value and determines if it matches a predetermined pattern matchstring composed of alphabetic, numeric, or literal characters.","url":"https://d3codex.com/processingcodes/p-pattern-match-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/p-pattern-match-processing-code.json"},{"slug":"processingcodes/processing-codes","title":"Processing codes","category":"Processing Codes","categorySlug":"processingcodes","summary":"This section discusses processing codes.","url":"https://d3codex.com/processingcodes/processing-codes/","api":"https://d3codex.com/api/topics/processingcodes/processing-codes.json"},{"slug":"processingcodes/processing-codes-commands","title":"Processing codes commands","category":"Processing Codes","categorySlug":"processingcodes","summary":"The following processing codes are available.","url":"https://d3codex.com/processingcodes/processing-codes-commands/","api":"https://d3codex.com/api/topics/processingcodes/processing-codes-commands.json"},{"slug":"processingcodes/processing-codes-overview","title":"Processing codes overview","category":"Processing Codes","categorySlug":"processingcodes","summary":"Processing codes describe database links and data manipulation rules in dictionaries. The D3 dictionary defines file layouts and data structures.","url":"https://d3codex.com/processingcodes/processing-codes-overview/","api":"https://d3codex.com/api/topics/processingcodes/processing-codes-overview.json"},{"slug":"processingcodes/r-range-processing-code","title":"r (range) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The r processing code invokes the range function, and restricts processing to those values that fall within given minimum and maximum range restrictions. Multiple range specifications allow display of the data value if the data value falls between any of the range pair sets. In using multiple range set specifications on negative values, the ranges should be in ascending sequence, beginning with the lowest.","url":"https://d3codex.com/processingcodes/r-range-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/r-range-processing-code.json"},{"slug":"processingcodes/s-subindex-processing-code","title":"s (subindex) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The s (Subindex) processing code is used to update an index that uses a file translation if the value in the translate file changes. This processing code is set from Attribute 8 of the File Definition Item for the data section of a translate file.","url":"https://d3codex.com/processingcodes/s-subindex-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/s-subindex-processing-code.json"},{"slug":"processingcodes/s-substitution-processing-code","title":"s (substitution) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The s processing code substitutes either a data value from the referenced attribute or literal text when the current data value is null or zero.","url":"https://d3codex.com/processingcodes/s-substitution-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/s-substitution-processing-code.json"},{"slug":"processingcodes/t-text-extraction-processing-code","title":"t (text extraction) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The t processing code provides a facility for extracting any number of characters from an attribute, starting at the position and length specified.","url":"https://d3codex.com/processingcodes/t-text-extraction-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/t-text-extraction-processing-code.json"},{"slug":"processingcodes/t-translate-processing-code","title":"t (translate) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The t processing code uses the presented value as an item-ID and attempts to retrieve the corresponding item in another file to obtain a value from one of its attributes to substitute.","url":"https://d3codex.com/processingcodes/t-translate-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/t-translate-processing-code.json"},{"slug":"processingcodes/u-user-exit-processing-code","title":"u (user exit) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"AQL user exits allow direct access to system functions.","url":"https://d3codex.com/processingcodes/u-user-exit-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/u-user-exit-processing-code.json"},{"slug":"processingcodes/v-value-limit-processing-code","title":"v (value limit) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The v processing code specifies the maximum number of values allowed in an attribute when as an input-conversion (attribute 14). If the v processing code is not defined, there is no limit to the number of values available in an attribute.","url":"https://d3codex.com/processingcodes/v-value-limit-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/v-value-limit-processing-code.json"},{"slug":"processingcodes/v-within-processing-code","title":"v (within) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The v processing code is used by the within connective and must be placed in the correlative attribute 8 of the file-defining item (D-pointer).","url":"https://d3codex.com/processingcodes/v-within-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/v-within-processing-code.json"},{"slug":"processingcodes/x-display-only-processing-code","title":"x (Display Only) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The x processing code is used as an input-conversion (attribute 14) and indicates that the specified attribute is for display only. The attribute cannot be updated.","url":"https://d3codex.com/processingcodes/x-display-only-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/x-display-only-processing-code.json"},{"slug":"processingcodes/x-update-stamp-processing-code","title":"x (update stamp) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The x processing code is placed in the correlative of a file-defining item to provide an audit trail for items that are updated via the Update processor.","url":"https://d3codex.com/processingcodes/x-update-stamp-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/x-update-stamp-processing-code.json"},{"slug":"processingcodes/xc-center-processing-code","title":"xc (center) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The xc processing code centers the input string in a field of spaces.","url":"https://d3codex.com/processingcodes/xc-center-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/xc-center-processing-code.json"},{"slug":"processingcodes/xi-input-conversion-processing-code","title":"xi (input conversion) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The xi processing code forces any further conversions to be treated as input-conversions.","url":"https://d3codex.com/processingcodes/xi-input-conversion-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/xi-input-conversion-processing-code.json"},{"slug":"processingcodes/xo-input-conversion-processing-code","title":"xo (output conversion) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The xo processing code forces any further conversions to be treated as output-conversions.","url":"https://d3codex.com/processingcodes/xo-input-conversion-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/xo-input-conversion-processing-code.json"},{"slug":"processingcodes/xr-running-subtotal-processing-code","title":"xr (running subtotal) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The xr processing code produces a running subtotal of an output column on an AQL listing or report.","url":"https://d3codex.com/processingcodes/xr-running-subtotal-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/xr-running-subtotal-processing-code.json"},{"slug":"processingcodes/xt-toggle-input-output-conversion-processing-code","title":"xt (toggle input/output conversion) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The xt processing code toggles the conversion direction from an input to an output-conversion or vice-versa.","url":"https://d3codex.com/processingcodes/xt-toggle-input-output-conversion-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/xt-toggle-input-output-conversion-processing-code.json"},{"slug":"processingcodes/y-update-stamping-processing-code","title":"y (update stamping) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The y processing code stamps user, PIB, and/or time/date update information into an internal item header from all processors.","url":"https://d3codex.com/processingcodes/y-update-stamping-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/y-update-stamping-processing-code.json"},{"slug":"processingcodes/za-assembly-code-format-processing-code","title":"za (assembly code format) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The za processing code displays a D3 item in a format compatible with assembly source code.","url":"https://d3codex.com/processingcodes/za-assembly-code-format-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/za-assembly-code-format-processing-code.json"},{"slug":"processingcodes/zc-zip-code-processing-code","title":"zc (zip code) processing code","category":"Processing Codes","categorySlug":"processingcodes","summary":"The zc processing code uses the zcf file to display the city, state, and Zip code. For international zip codes, an additional country file is used. For U.S.A. zip codes, zc displays a standard 5-digit zip code or the zip+4 code.","url":"https://d3codex.com/processingcodes/zc-zip-code-processing-code/","api":"https://d3codex.com/api/topics/processingcodes/zc-zip-code-processing-code.json"},{"slug":"runoff/ampersand-caret-function","title":"&^ function","category":"Runoff","categorySlug":"runoff","summary":"The &^ function puts Runoff in underline mode until an &\\ is encountered.","url":"https://d3codex.com/runoff/ampersand-caret-function/","api":"https://d3codex.com/api/topics/runoff/ampersand-caret-function.json"},{"slug":"runoff/ampersand-function","title":"& function","category":"Runoff","categorySlug":"runoff","summary":"The & function underlines the following character. The character to be underlined must immediately follow the & character. If the & character is followed by a space, the & character itself is printed.","url":"https://d3codex.com/runoff/ampersand-function/","api":"https://d3codex.com/api/topics/runoff/ampersand-function.json"},{"slug":"runoff/ampersnad-backslash-function","title":"&\\ function","category":"Runoff","categorySlug":"runoff","summary":"The &\\ function turns off the underline mode.","url":"https://d3codex.com/runoff/ampersnad-backslash-function/","api":"https://d3codex.com/api/topics/runoff/ampersnad-backslash-function.json"},{"slug":"runoff/at-backslash-function","title":"@\\ function","category":"Runoff","categorySlug":"runoff","summary":"The @\\ function turns off boldface mode.","url":"https://d3codex.com/runoff/at-backslash-function/","api":"https://d3codex.com/api/topics/runoff/at-backslash-function.json"},{"slug":"runoff/at-caret-function","title":"@^ function","category":"Runoff","categorySlug":"runoff","summary":"The @^ function enables boldface mode. Runoff remains in boldface mode until a @\\ is encountered. The number of times the boldface letters are printed may be set by using the number option of the Runoff command.","url":"https://d3codex.com/runoff/at-caret-function/","api":"https://d3codex.com/api/topics/runoff/at-caret-function.json"},{"slug":"runoff/at-function","title":"@ function","category":"Runoff","categorySlug":"runoff","summary":"The @ function boldfaces the following character. The character to be boldfaced must immediately follow the @ symbol. If the @ symbol is followed by a space, the @ character itself is printed.","url":"https://d3codex.com/runoff/at-function/","api":"https://d3codex.com/api/topics/runoff/at-function.json"},{"slug":"runoff/backslash-backslash-function","title":"\\\\ function","category":"Runoff","categorySlug":"runoff","summary":"The \\\\ function turns off uppercase mode and causes the text to switch to lowercase in the same way that the .lower case command causes the switch, except that \\\\ may be imbedded in a line. Turning off this function requires the .end case command.","url":"https://d3codex.com/runoff/backslash-backslash-function/","api":"https://d3codex.com/api/topics/runoff/backslash-backslash-function.json"},{"slug":"runoff/backslash-function","title":"\\ function","category":"Runoff","categorySlug":"runoff","summary":"The \\ function prints the following character in lowercase. The character to be printed in lowercase must immediately follow the \\ character. If the \\ character is followed by a space, the character itself is printed.","url":"https://d3codex.com/runoff/backslash-function/","api":"https://d3codex.com/api/topics/runoff/backslash-function.json"},{"slug":"runoff/caret-caret-function","title":"^^ function","category":"Runoff","categorySlug":"runoff","summary":"The ^^ function activates the uppercase mode and causes the text to switch to uppercase in the same way that the .upper case command causes the switch, except that ^^ may be imbedded in a line. Turning off this function requires the .end case command.","url":"https://d3codex.com/runoff/caret-caret-function/","api":"https://d3codex.com/api/topics/runoff/caret-caret-function.json"},{"slug":"runoff/caret-function","title":"^ function","category":"Runoff","categorySlug":"runoff","summary":"The ^ function prints the following character in uppercase. The character to be printed in uppercase must immediately follow the ^ character. If the ^ character is followed by a space, the ^ character itself is printed.","url":"https://d3codex.com/runoff/caret-function/","api":"https://d3codex.com/api/topics/runoff/caret-function.json"},{"slug":"runoff/control-functions","title":"Control functions","category":"Runoff","categorySlug":"runoff","summary":"Runoff features special control functions for uppercase and lowercase control, underlining, boldface printing, tabbing, and special character override.","url":"https://d3codex.com/runoff/control-functions/","api":"https://d3codex.com/api/topics/runoff/control-functions.json"},{"slug":"runoff/dot-asterisk-function","title":".* function","category":"Runoff","categorySlug":"runoff","summary":"The .* function treats the entire line following the command as a remark. Any text following the command is not output by Runoff.","url":"https://d3codex.com/runoff/dot-asterisk-function/","api":"https://d3codex.com/api/topics/runoff/dot-asterisk-function.json"},{"slug":"runoff/dot-b-command","title":".b command","category":"Runoff","categorySlug":"runoff","summary":"The .b command outputs a partially filled line before processing the next line.","url":"https://d3codex.com/runoff/dot-b-command/","api":"https://d3codex.com/api/topics/runoff/dot-b-command.json"},{"slug":"runoff/dot-begin-page-command-runoff","title":".begin page command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .begin page command executes a .break command followed by an advance to a new page. The page number is incremented and the page heading (if set) is printed.","url":"https://d3codex.com/runoff/dot-begin-page-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-begin-page-command-runoff.json"},{"slug":"runoff/dot-box-command-runoff","title":".box command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .box command defines the left and right margin boundaries for a box around the text, and encloses the following text in a box of vertical bars on the output page. The .box off command turns off the box effect previously started with a .box command.","url":"https://d3codex.com/runoff/dot-box-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-box-command-runoff.json"},{"slug":"runoff/dot-break-command-runoff","title":".break command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .break command creates a new paragraph.","url":"https://d3codex.com/runoff/dot-break-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-break-command-runoff.json"},{"slug":"runoff/dot-capitalize-sentences-command","title":".capitalize sentences command","category":"Runoff","categorySlug":"runoff","summary":"The .capitalize sentences command capitalizes sentences following a period, exclamation point, question mark, colon, or a semicolon that is followed by one or more spaces. If the first word of the sentence is already capitalized, it remains capitalized. The .nocapitalize sentences command disables the .capitalize sentences command.","url":"https://d3codex.com/runoff/dot-capitalize-sentences-command/","api":"https://d3codex.com/api/topics/runoff/dot-capitalize-sentences-command.json"},{"slug":"runoff/dot-center-command-runoff","title":".center command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .center command outputs the next line of the document in nofill mode and centers it on the next line of output. This command causes a break (new paragraph) to occur.","url":"https://d3codex.com/runoff/dot-center-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-center-command-runoff.json"},{"slug":"runoff/dot-chain-command-runoff","title":".chain command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .chain command transfers control to the specified item-ID.","url":"https://d3codex.com/runoff/dot-chain-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-chain-command-runoff.json"},{"slug":"runoff/dot-chapter-command-runoff","title":".chapter command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .chapter command ejects a page, increments the page and chapter counters, and outputs the literal, Chapter, followed by the optional text, centered between the current margins. The chapter, page number, and text are accumulated for the table of contents.","url":"https://d3codex.com/runoff/dot-chapter-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-chapter-command-runoff.json"},{"slug":"runoff/dot-contents-command","title":".contents command","category":"Runoff","categorySlug":"runoff","summary":"The .contents command outputs the current table of contents, as defined by the previous .chapter and .section commands.","url":"https://d3codex.com/runoff/dot-contents-command/","api":"https://d3codex.com/api/topics/runoff/dot-contents-command.json"},{"slug":"runoff/dot-crt-command-runoff","title":".crt command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .crt command directs text unconditionally to the terminal screen.","url":"https://d3codex.com/runoff/dot-crt-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-crt-command-runoff.json"},{"slug":"runoff/dot-end-case-command-runoff","title":".end case command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .end case command disables any previous .upper case or .lower case commands.","url":"https://d3codex.com/runoff/dot-end-case-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-end-case-command-runoff.json"},{"slug":"runoff/dot-fill-command","title":".fill command","category":"Runoff","categorySlug":"runoff","summary":"The .fill command enters line fill mode. Words are processed until there are enough to fill a line without overflowing it. If justification mode is on, Runoff inserts spaces in the line at random to make the right margin line up.","url":"https://d3codex.com/runoff/dot-fill-command/","api":"https://d3codex.com/api/topics/runoff/dot-fill-command.json"},{"slug":"runoff/dot-footing-command-runoff","title":".footing command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .footing command designates a text string composed of literals and special options to output at the bottom of each page. If the line following the .footing command is null, the footing is suppressed. The .footing command places the footing text in a buffer and is only processed during a break page, either explicitly with a .bp command or by data.","url":"https://d3codex.com/runoff/dot-footing-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-footing-command-runoff.json"},{"slug":"runoff/dot-heading-command-runoff","title":".heading command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .heading command designates a text string composed of literals and special options to output at the top of each page. If the line following the .heading command is null, the heading is suppressed. The .heading command places the heading text in a buffer and is only processed during a break page, either explicitly with a .bp command or by data.","url":"https://d3codex.com/runoff/dot-heading-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-heading-command-runoff.json"},{"slug":"runoff/dot-hilite-command-runoff","title":".hilite command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .hilite command prints the optionally-specified character along the right margin. If the character is omitted, or the word off displays after the command, the .hilite command is disabled. The .hilite off command terminates the .hilite command.","url":"https://d3codex.com/runoff/dot-hilite-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-hilite-command-runoff.json"},{"slug":"runoff/dot-indent-command-runoff","title":".indent command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .indent command indents the text following the command a specified number of spaces from the left margin.","url":"https://d3codex.com/runoff/dot-indent-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-indent-command-runoff.json"},{"slug":"runoff/dot-indent-margin-command-runoff","title":".indent margin command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .indent margin command increments the left margin by the specified number of spaces.","url":"https://d3codex.com/runoff/dot-indent-margin-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-indent-margin-command-runoff.json"},{"slug":"runoff/dot-index-command-runoff","title":".index command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .index command places the text and the current page number into the document’s index.","url":"https://d3codex.com/runoff/dot-index-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-index-command-runoff.json"},{"slug":"runoff/dot-input-command-runoff","title":".input command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .input command accepts and processes text input from the terminal. The text entered is output as though it had been stored in the document.","url":"https://d3codex.com/runoff/dot-input-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-input-command-runoff.json"},{"slug":"runoff/dot-justify-command-runoff","title":".justify command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .justify command enables the .fill and .justify commands. The .justify command is one of the .standard command settings. The .nojustify command terminates the .justify command.","url":"https://d3codex.com/runoff/dot-justify-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-justify-command-runoff.json"},{"slug":"runoff/dot-left-margin-command-runoff","title":".left margin command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .left margin command sets the left margin at a specific number of spaces from the left edge of the paper. The left margin is automatically set to 0 in the .standard command.","url":"https://d3codex.com/runoff/dot-left-margin-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-left-margin-command-runoff.json"},{"slug":"runoff/dot-line-length-command-runoff","title":".line length command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .line length command sets the line length a specified number of characters from the left margin. Line length is automatically set to 70 in the .standard command.","url":"https://d3codex.com/runoff/dot-line-length-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-line-length-command-runoff.json"},{"slug":"runoff/dot-lower-case-command-runoff","title":".lower case command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .lower case command outputs text in lowercase characters. The .end case command terminates this command.","url":"https://d3codex.com/runoff/dot-lower-case-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-lower-case-command-runoff.json"},{"slug":"runoff/dot-lptr-command","title":".lptr command","category":"Runoff","categorySlug":"runoff","summary":"The .lptr command directs output to the system printer, via the Spooler.","url":"https://d3codex.com/runoff/dot-lptr-command/","api":"https://d3codex.com/api/topics/runoff/dot-lptr-command.json"},{"slug":"runoff/dot-lx-command","title":".lx command","category":"Runoff","categorySlug":"runoff","summary":"The .lx command sets the auto-tab to a specified column number.","url":"https://d3codex.com/runoff/dot-lx-command/","api":"https://d3codex.com/api/topics/runoff/dot-lx-command.json"},{"slug":"runoff/dot-nocapitalize-sentences-command","title":".nocapitalize sentences command","category":"Runoff","categorySlug":"runoff","summary":"The .nocapitalize sentences command deactivates the automatic capitalization of sentences mode.","url":"https://d3codex.com/runoff/dot-nocapitalize-sentences-command/","api":"https://d3codex.com/api/topics/runoff/dot-nocapitalize-sentences-command.json"},{"slug":"runoff/dot-nofill-command-runoff","title":".nofill command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .nofill command resets both the justify and fill modes. Removal of extra spaces does not take place, and end-of-lines are not stripped from the input. Output lines are not filled nor are right margins justified. The .nofill command causes a break (new paragraph).","url":"https://d3codex.com/runoff/dot-nofill-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-nofill-command-runoff.json"},{"slug":"runoff/dot-nojustify-command","title":".nojustify command","category":"Runoff","categorySlug":"runoff","summary":"The .nojustify command disables the justification mode. The fill mode remains in effect.","url":"https://d3codex.com/runoff/dot-nojustify-command/","api":"https://d3codex.com/api/topics/runoff/dot-nojustify-command.json"},{"slug":"runoff/dot-noparagraph-command","title":".noparagraph command","category":"Runoff","categorySlug":"runoff","summary":"The .noparagraph command turns off the .paragraph command.","url":"https://d3codex.com/runoff/dot-noparagraph-command/","api":"https://d3codex.com/api/topics/runoff/dot-noparagraph-command.json"},{"slug":"runoff/dot-page-number-command-runoff","title":".page number command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .page number command sets the current page number to a specified number.","url":"https://d3codex.com/runoff/dot-page-number-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-page-number-command-runoff.json"},{"slug":"runoff/dot-paper-length-command","title":".paper length command","category":"Runoff","categorySlug":"runoff","summary":"The .paper length command specifies the maximum number of print lines per output page.","url":"https://d3codex.com/runoff/dot-paper-length-command/","api":"https://d3codex.com/api/topics/runoff/dot-paper-length-command.json"},{"slug":"runoff/dot-paragraph-command-runoff","title":".paragraph command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .paragraph command specifies the number of spaces for paragraph indentation. Any blank line or any line beginning with a space is indented the specified number of spaces.","url":"https://d3codex.com/runoff/dot-paragraph-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-paragraph-command-runoff.json"},{"slug":"runoff/dot-pfile-command","title":".pfile command","category":"Runoff","categorySlug":"runoff","summary":"The .pfile command creates a separate Spooler entry containing the table of contents created with the .contents command. The .pfile command directs subsequent output to the specified print file number, just like the print on statement in FlashBASIC.","url":"https://d3codex.com/runoff/dot-pfile-command/","api":"https://d3codex.com/api/topics/runoff/dot-pfile-command.json"},{"slug":"runoff/dot-print-command","title":".print command","category":"Runoff","categorySlug":"runoff","summary":"The .print command prints the next line of text on the terminal. This command is used in conjunction with the .input command.","url":"https://d3codex.com/runoff/dot-print-command/","api":"https://d3codex.com/api/topics/runoff/dot-print-command.json"},{"slug":"runoff/dot-print-index-command-runoff","title":".print index command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .print index command prints the sorted index of words and page numbers. The index is sorted in alphabetical order, and printed two columns per page. The .print index command changes the tab settings, and issues a .begin page command.","url":"https://d3codex.com/runoff/dot-print-index-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-print-index-command-runoff.json"},{"slug":"runoff/dot-read-command-runoff","title":".read command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .read command transfers control to the specified Runoff item for output and returns control upon completion.","url":"https://d3codex.com/runoff/dot-read-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-read-command-runoff.json"},{"slug":"runoff/dot-readnext-command-runoff","title":".readnext command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .readnext command extracts the top entry of an active list created by one of the list-generating commands prior to output and inserts the value into the text of the item.","url":"https://d3codex.com/runoff/dot-readnext-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-readnext-command-runoff.json"},{"slug":"runoff/dot-save-index-command-runoff","title":".save index command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .save index command saves entries defined in previous .index commands in the specified file reference, using the item-ID of the current Runoff item. The file reference of the index must be different than the current file reference to avoid destroying data. This command causes chapter and page number information of indexed data in a text to be saved in a separate file. Each index entry is stored as an individual item using the index entry as the item-ID, the chapter (where that index entry is referenced) as the first attribute and the page number as the second attribute. Multiple values are stored in these attributes as multiple references to the same index entry. The resulting file may then be operated on by the AQL processor to generate listings for the chapter and page number information of all indexed data in a text. The .save index command is placed in the text item itself and must precede the .index commands. Only indexed data that has been preceded by the .save index command is saved in the specified file.","url":"https://d3codex.com/runoff/dot-save-index-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-save-index-command-runoff.json"},{"slug":"runoff/dot-section-command-runoff","title":".section command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .section command handles automatic chapter section numbering and formatting, in conjunction with the .chapter command.","url":"https://d3codex.com/runoff/dot-section-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-section-command-runoff.json"},{"slug":"runoff/dot-set-tabs-command","title":".set tabs command","category":"Runoff","categorySlug":"runoff","summary":"The .set tabs command clears previous tab stops and specifies tab stop locations at specified column position.","url":"https://d3codex.com/runoff/dot-set-tabs-command/","api":"https://d3codex.com/api/topics/runoff/dot-set-tabs-command.json"},{"slug":"runoff/dot-skip-command-runoff","title":".skip command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .skip command outputs a specific number of blank lines on a page, taking into account any previously specified .spacing commands.","url":"https://d3codex.com/runoff/dot-skip-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-skip-command-runoff.json"},{"slug":"runoff/dot-space-command-runoff","title":".space command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .space command outputs a specific number of blank lines on a page, regardless of any previously specified .spacing commands.","url":"https://d3codex.com/runoff/dot-space-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-space-command-runoff.json"},{"slug":"runoff/dot-spacing-command-runoff","title":".spacing command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .spacing command specifies interline spacing to the specified number of lines.","url":"https://d3codex.com/runoff/dot-spacing-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-spacing-command-runoff.json"},{"slug":"runoff/dot-standard-command-runoff","title":".standard command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .standard command defines the default parameter and mode settings for Runoff text.","url":"https://d3codex.com/runoff/dot-standard-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-standard-command-runoff.json"},{"slug":"runoff/dot-test-page-command-runoff","title":".test page command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .test page command tests the number of lines left on the current page and determines whether text is output on the current or next page.","url":"https://d3codex.com/runoff/dot-test-page-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-test-page-command-runoff.json"},{"slug":"runoff/dot-upper-case-command-runoff","title":".upper case command (Runoff)","category":"Runoff","categorySlug":"runoff","summary":"The .upper case command outputs text in uppercase characters, unless specifically altered by the \\ lowercase special control function. The .end case command terminates the .upper case command.","url":"https://d3codex.com/runoff/dot-upper-case-command-runoff/","api":"https://d3codex.com/api/topics/runoff/dot-upper-case-command-runoff.json"},{"slug":"runoff/function","title":"_ function","category":"Runoff","categorySlug":"runoff","summary":"The _ function treats the following character as a text character, rather than as a control character.","url":"https://d3codex.com/runoff/function/","api":"https://d3codex.com/api/topics/runoff/function.json"},{"slug":"runoff/greater-than-function","title":"> function","category":"Runoff","categorySlug":"runoff","summary":"The > function causes the following word to end at the next defined tab stop. The tab stop positions are defined using the .set tabs command. Tab characters are only in effect in the nofill mode.","url":"https://d3codex.com/runoff/greater-than-function/","api":"https://d3codex.com/api/topics/runoff/greater-than-function.json"},{"slug":"runoff/less-than-function","title":"< function","category":"Runoff","categorySlug":"runoff","summary":"The < function causes the following word to begin at the next defined tab stop. The tab stop positions are defined using the .set tabs command. Tab characters are only in effect in the nofill mode.","url":"https://d3codex.com/runoff/less-than-function/","api":"https://d3codex.com/api/topics/runoff/less-than-function.json"},{"slug":"runoff/runoff-command-runoff-processor","title":"runoff command (Runoff processor)","category":"Runoff","categorySlug":"runoff","summary":"The runoff command invokes the output function of the Runoff processor.","url":"https://d3codex.com/runoff/runoff-command-runoff-processor/","api":"https://d3codex.com/api/topics/runoff/runoff-command-runoff-processor.json"},{"slug":"runoff/runoff-commands","title":"Runoff commands","category":"Runoff","categorySlug":"runoff","summary":"Runoff commands are stored along with the textual material in the source file. A period must precede each Runoff command. For consistency, all Runoff commands are typed in lowercase letters.","url":"https://d3codex.com/runoff/runoff-commands/","api":"https://d3codex.com/api/topics/runoff/runoff-commands.json"},{"slug":"runoff/runoff-processor","title":"Runoff processor","category":"Runoff","categorySlug":"runoff","summary":"This section discusses the Runoff processor.","url":"https://d3codex.com/runoff/runoff-processor/","api":"https://d3codex.com/api/topics/runoff/runoff-processor.json"},{"slug":"runoff/runoff-processor-overview","title":"Runoff processor overview","category":"Runoff","categorySlug":"runoff","summary":"The Runoff text processor facilitates the preparation and maintenance of textual material such as memos, manuals, and so on.","url":"https://d3codex.com/runoff/runoff-processor-overview/","api":"https://d3codex.com/api/topics/runoff/runoff-processor-overview.json"},{"slug":"systemfiles/abs-file","title":"abs file","category":"System Files","categorySlug":"systemfiles","summary":"The abs file contains information about the binary executable object module, which is the D3 System.","url":"https://d3codex.com/systemfiles/abs-file/","api":"https://d3codex.com/api/topics/systemfiles/abs-file.json"},{"slug":"systemfiles/accounts-file","title":"accounts file","category":"System Files","categorySlug":"systemfiles","summary":"The accounts file contains a history of computer usage by user.","url":"https://d3codex.com/systemfiles/accounts-file/","api":"https://d3codex.com/api/topics/systemfiles/accounts-file.json"},{"slug":"systemfiles/backgrounds-file","title":"backgrounds file","category":"System Files","categorySlug":"systemfiles","summary":"The backgrounds file contains data for each background process submitted for execution. The item-ID is a user specified string to uniquely identify the background job.","url":"https://d3codex.com/systemfiles/backgrounds-file/","api":"https://d3codex.com/api/topics/systemfiles/backgrounds-file.json"},{"slug":"systemfiles/binary-files-system-files","title":"Binary files (system files)","category":"System Files","categorySlug":"systemfiles","summary":"Binary files are used to access binary items through the OSFI. It is possible to access binary items as if they were normal D3 items, using AQL, BASIC, FlashBASIC, and so on.","url":"https://d3codex.com/systemfiles/binary-files-system-files/","api":"https://d3codex.com/api/topics/systemfiles/binary-files-system-files.json"},{"slug":"systemfiles/block-convert-file","title":"block-convert file","category":"System Files","categorySlug":"systemfiles","summary":"The block-convert file contains the instructions used by the TCL command block-print to display enlarged characters.","url":"https://d3codex.com/systemfiles/block-convert-file/","api":"https://d3codex.com/api/topics/systemfiles/block-convert-file.json"},{"slug":"systemfiles/bp-file","title":"bp file","category":"System Files","categorySlug":"systemfiles","summary":"The bp file contains BASIC source programs for system utilities.","url":"https://d3codex.com/systemfiles/bp-file/","api":"https://d3codex.com/api/topics/systemfiles/bp-file.json"},{"slug":"systemfiles/bulletin-file","title":"bulletin file","category":"System Files","categorySlug":"systemfiles","summary":"The bulletin file contains company messages to display at logon time.","url":"https://d3codex.com/systemfiles/bulletin-file/","api":"https://d3codex.com/api/topics/systemfiles/bulletin-file.json"},{"slug":"systemfiles/cap-file-file","title":"cap-file File","category":"System Files","categorySlug":"systemfiles","summary":"The cap-file file captures the screen output from the converse command. The item-ID used consists of *port.number.","url":"https://d3codex.com/systemfiles/cap-file-file/","api":"https://d3codex.com/api/topics/systemfiles/cap-file-file.json"},{"slug":"systemfiles/captcl-file","title":"captcl file","category":"System Files","categorySlug":"systemfiles","summary":"The captcl file captures the screen output from the capture-on command. The item-ID used consists of account.name*port.number.","url":"https://d3codex.com/systemfiles/captcl-file/","api":"https://d3codex.com/api/topics/systemfiles/captcl-file.json"},{"slug":"systemfiles/clashes-file","title":"clashes file","category":"System Files","categorySlug":"systemfiles","summary":"The clashes file holds invalid items removed from the master dictionary by the update-md program. Each account updated gets its own data section in the clashes file. The command, lf dm,clashes, displays these data sections.","url":"https://d3codex.com/systemfiles/clashes-file/","api":"https://d3codex.com/api/topics/systemfiles/clashes-file.json"},{"slug":"systemfiles/country-file","title":"country file","category":"System Files","categorySlug":"systemfiles","summary":"The country file defines the postal codes of countries, as part of the zip code processing code.","url":"https://d3codex.com/systemfiles/country-file/","api":"https://d3codex.com/api/topics/systemfiles/country-file.json"},{"slug":"systemfiles/devices-file","title":"devices file","category":"System Files","categorySlug":"systemfiles","summary":"The devices file contains an item for every terminal or printer device recognized by the D3 System. The actual escape sequences produced by @ functions in BASIC and PROC are defined within these device drivers.","url":"https://d3codex.com/systemfiles/devices-file/","api":"https://d3codex.com/api/topics/systemfiles/devices-file.json"},{"slug":"systemfiles/devs-file","title":"devs file","category":"System Files","categorySlug":"systemfiles","summary":"The devs file defines the various devices in the system.","url":"https://d3codex.com/systemfiles/devs-file/","api":"https://d3codex.com/api/topics/systemfiles/devs-file.json"},{"slug":"systemfiles/dm-bp-pointer","title":"dm-bp pointer","category":"System Files","categorySlug":"systemfiles","summary":"The dm-bp file is a Q-pointer for the bp file on the dm account.","url":"https://d3codex.com/systemfiles/dm-bp-pointer/","api":"https://d3codex.com/api/topics/systemfiles/dm-bp-pointer.json"},{"slug":"systemfiles/errmsg-pointer","title":"errmsg pointer","category":"System Files","categorySlug":"systemfiles","summary":"The errmsg file is a Q-pointer to the errors file.","url":"https://d3codex.com/systemfiles/errmsg-pointer/","api":"https://d3codex.com/api/topics/systemfiles/errmsg-pointer.json"},{"slug":"systemfiles/errors-file","title":"errors file","category":"System Files","categorySlug":"systemfiles","summary":"The errors file contains system error and log-msg messages used to determine how the system is functioning.","url":"https://d3codex.com/systemfiles/errors-file/","api":"https://d3codex.com/api/topics/systemfiles/errors-file.json"},{"slug":"systemfiles/file-of-files-file-vme","title":"File-of-files file (VME)","category":"System Files","categorySlug":"systemfiles","summary":"The file named file-of-files contains statistical information for each file on the system. Whenever a file is created, restored, or deleted, this file is updated.","url":"https://d3codex.com/systemfiles/file-of-files-file-vme/","api":"https://d3codex.com/api/topics/systemfiles/file-of-files-file-vme.json"},{"slug":"systemfiles/fileoffiles-file-fsi","title":"FileOfFiles file (FSI)","category":"System Files","categorySlug":"systemfiles","summary":"The file named FileOfFiles contains statistical information for each file in the FSI. Whenever a file is created, restored, or deleted, this file is updated.","url":"https://d3codex.com/systemfiles/fileoffiles-file-fsi/","api":"https://d3codex.com/api/topics/systemfiles/fileoffiles-file-fsi.json"},{"slug":"systemfiles/fonts-file","title":"fonts file","category":"System Files","categorySlug":"systemfiles","summary":"The fonts file contains downloadable printer fonts.","url":"https://d3codex.com/systemfiles/fonts-file/","api":"https://d3codex.com/api/topics/systemfiles/fonts-file.json"},{"slug":"systemfiles/funckeys-file","title":"funckeys file","category":"System Files","categorySlug":"systemfiles","summary":"The funckeys file contains preset function key definition items and is used with the TCL set-func command.","url":"https://d3codex.com/systemfiles/funckeys-file/","api":"https://d3codex.com/api/topics/systemfiles/funckeys-file.json"},{"slug":"systemfiles/gsym-file","title":"gsym file","category":"System Files","categorySlug":"systemfiles","summary":"The gsym file is the global symbol file in the dm account.","url":"https://d3codex.com/systemfiles/gsym-file/","api":"https://d3codex.com/api/topics/systemfiles/gsym-file.json"},{"slug":"systemfiles/host-operating-system-files","title":"Host operating system files","category":"System Files","categorySlug":"systemfiles","summary":"Through the OSFI, it is possible to access host operating system files as if they were D3 items, using AQL, BASIC, FlashBASIC, and so on. This section describes the format of the Q-pointer, the file structure and the access rules.","url":"https://d3codex.com/systemfiles/host-operating-system-files/","api":"https://d3codex.com/api/topics/systemfiles/host-operating-system-files.json"},{"slug":"systemfiles/hosts-file","title":"hosts file","category":"System Files","categorySlug":"systemfiles","summary":"The hosts file defines file system connections to remote environments.","url":"https://d3codex.com/systemfiles/hosts-file/","api":"https://d3codex.com/api/topics/systemfiles/hosts-file.json"},{"slug":"systemfiles/hotkey-all-file","title":"hotkey.all file","category":"System Files","categorySlug":"systemfiles","summary":"The hotkey.all file specifies the name of a FlashBASIC or BASIC subroutine to execute according to the rules described under Hot Key Commands.","url":"https://d3codex.com/systemfiles/hotkey-all-file/","api":"https://d3codex.com/api/topics/systemfiles/hotkey-all-file.json"},{"slug":"systemfiles/iomap-file-file","title":"iomap-file file","category":"System Files","categorySlug":"systemfiles","summary":"The iomap-file file defines the one-to-one keyboard input and output translation used by the set-iomap command.","url":"https://d3codex.com/systemfiles/iomap-file-file/","api":"https://d3codex.com/api/topics/systemfiles/iomap-file-file.json"},{"slug":"systemfiles/jobs-file","title":"jobs file","category":"System Files","categorySlug":"systemfiles","summary":"The jobs file contains data for each phantom job submitted for execution.","url":"https://d3codex.com/systemfiles/jobs-file/","api":"https://d3codex.com/api/topics/systemfiles/jobs-file.json"},{"slug":"systemfiles/kb-fk-file","title":"kb.fk File","category":"System Files","categorySlug":"systemfiles","summary":"The kb.fk file sets the keyboard for UNIX.","url":"https://d3codex.com/systemfiles/kb-fk-file/","api":"https://d3codex.com/api/topics/systemfiles/kb-fk-file.json"},{"slug":"systemfiles/kb-pc-file","title":"kb.pc file","category":"System Files","categorySlug":"systemfiles","summary":"The kb.pc file maps the keyboard.","url":"https://d3codex.com/systemfiles/kb-pc-file/","api":"https://d3codex.com/api/topics/systemfiles/kb-pc-file.json"},{"slug":"systemfiles/keyboards-file","title":"keyboards file","category":"System Files","categorySlug":"systemfiles","summary":"The keyboards file contains keyboard definitions and translations.","url":"https://d3codex.com/systemfiles/keyboards-file/","api":"https://d3codex.com/api/topics/systemfiles/keyboards-file.json"},{"slug":"systemfiles/logoffs-file","title":"logoffs file","category":"System Files","categorySlug":"systemfiles","summary":"The logoffs file contains a snapshot of the where status of the pib and the process status of the process id before ’logging off’ and after. This file is updated by the TCL commands logoff and reset-user.","url":"https://d3codex.com/systemfiles/logoffs-file/","api":"https://d3codex.com/api/topics/systemfiles/logoffs-file.json"},{"slug":"systemfiles/master-dictionary-file","title":"Master dictionary file","category":"System Files","categorySlug":"systemfiles","summary":"The master dictionary file contains commands, Procs, Macros, Menus, connectives, default attribute-defining items, file-defining items (both local (D-pointers) and synonym (Q-pointers)) and cataloged FlashBASIC programs.","url":"https://d3codex.com/systemfiles/master-dictionary-file/","api":"https://d3codex.com/api/topics/systemfiles/master-dictionary-file.json"},{"slug":"systemfiles/mds-file","title":"mds file","category":"System Files","categorySlug":"systemfiles","summary":"The mds file is the highest level file in the D3 file structure and resides on the dm account.","url":"https://d3codex.com/systemfiles/mds-file/","api":"https://d3codex.com/api/topics/systemfiles/mds-file.json"},{"slug":"systemfiles/messages-file","title":"messages file","category":"System Files","categorySlug":"systemfiles","summary":"The messages file contains messages used by system processes to convey information to the user.","url":"https://d3codex.com/systemfiles/messages-file/","api":"https://d3codex.com/api/topics/systemfiles/messages-file.json"},{"slug":"systemfiles/newac-file","title":"newac file","category":"System Files","categorySlug":"systemfiles","summary":"The newac file contains all of the master dictionary file items that are copied to each new D3 account.","url":"https://d3codex.com/systemfiles/newac-file/","api":"https://d3codex.com/api/topics/systemfiles/newac-file.json"},{"slug":"systemfiles/object-queue-file","title":"object.queue file","category":"System Files","categorySlug":"systemfiles","summary":"D3 shares FlashBASIC object code between all processes running a given program. While this vastly decreases memory requirements, it also opens the possibility of one user compiling a program while another user is concurrently running that same routine. This circumstance tends to produce random, unexplainable aborts that can be difficult to track on large systems.","url":"https://d3codex.com/systemfiles/object-queue-file/","api":"https://d3codex.com/api/topics/systemfiles/object-queue-file.json"},{"slug":"systemfiles/peqs-file","title":"peqs file","category":"System Files","categorySlug":"systemfiles","summary":"The peqs file is a super Q-pointer used to access print jobs.","url":"https://d3codex.com/systemfiles/peqs-file/","api":"https://d3codex.com/api/topics/systemfiles/peqs-file.json"},{"slug":"systemfiles/pibs-file","title":"pibs file","category":"System Files","categorySlug":"systemfiles","summary":"The pibs file contains device specifications for each port.","url":"https://d3codex.com/systemfiles/pibs-file/","api":"https://d3codex.com/api/topics/systemfiles/pibs-file.json"},{"slug":"systemfiles/pointer-file-file","title":"pointer-file file","category":"System Files","categorySlug":"systemfiles","summary":"The pointer-file file is the default file that contains items from save-list commands.","url":"https://d3codex.com/systemfiles/pointer-file-file/","api":"https://d3codex.com/api/topics/systemfiles/pointer-file-file.json"},{"slug":"systemfiles/resizing-file","title":"resizing file","category":"System Files","categorySlug":"systemfiles","summary":"The resizing file contains information about files currently being resized.","url":"https://d3codex.com/systemfiles/resizing-file/","api":"https://d3codex.com/api/topics/systemfiles/resizing-file.json"},{"slug":"systemfiles/restore-errors-file","title":"restore-errors file","category":"System Files","categorySlug":"systemfiles","summary":"The restore-errors file contains errors that occurred during a restore.","url":"https://d3codex.com/systemfiles/restore-errors-file/","api":"https://d3codex.com/api/topics/systemfiles/restore-errors-file.json"},{"slug":"systemfiles/runtime-errors-file","title":"runtime-errors file","category":"System Files","categorySlug":"systemfiles","summary":"The runtime-errors file contains information about any runtime errors that occur during the execution of a BASIC or FlashBASIC program.","url":"https://d3codex.com/systemfiles/runtime-errors-file/","api":"https://d3codex.com/api/topics/systemfiles/runtime-errors-file.json"},{"slug":"systemfiles/state-file","title":"state file","category":"System Files","categorySlug":"systemfiles","summary":"The state file lists the states, counties, and provinces of various countries as part of the zip code processing code.","url":"https://d3codex.com/systemfiles/state-file/","api":"https://d3codex.com/api/topics/systemfiles/state-file.json"},{"slug":"systemfiles/system-files","title":"System files","category":"System Files","categorySlug":"systemfiles","summary":"The system file is the highest-level file in the D3 file hierarchy.","url":"https://d3codex.com/systemfiles/system-files/","api":"https://d3codex.com/api/topics/systemfiles/system-files.json"},{"slug":"systemfiles/tcl-stack-file","title":"tcl-stack file","category":"System Files","categorySlug":"systemfiles","summary":"The tcl-stack file keeps a record of all commands issued from TCL.","url":"https://d3codex.com/systemfiles/tcl-stack-file/","api":"https://d3codex.com/api/topics/systemfiles/tcl-stack-file.json"},{"slug":"systemfiles/tv-log-file","title":"tv.log file","category":"System Files","categorySlug":"systemfiles","summary":"The tv.log file records t-verify errors when the option is chosen to verify the tape during a file-save.","url":"https://d3codex.com/systemfiles/tv-log-file/","api":"https://d3codex.com/api/topics/systemfiles/tv-log-file.json"},{"slug":"systemfiles/upgrade-file-file","title":"upgrade.file file","category":"System Files","categorySlug":"systemfiles","summary":"The upgrade.file contains the BASIC programs, verbs and error messages that are used by the nt_upgrade procedure.","url":"https://d3codex.com/systemfiles/upgrade-file-file/","api":"https://d3codex.com/api/topics/systemfiles/upgrade-file-file.json"},{"slug":"systemfiles/users-file","title":"users file","category":"System Files","categorySlug":"systemfiles","summary":"The users file contains specific data relevant to each individual authorized user on the system.","url":"https://d3codex.com/systemfiles/users-file/","api":"https://d3codex.com/api/topics/systemfiles/users-file.json"},{"slug":"systemfiles/var-file","title":"var File","category":"System Files","categorySlug":"systemfiles","summary":"The var file is a pseudo file that maps to the user’s TCL shell variables.","url":"https://d3codex.com/systemfiles/var-file/","api":"https://d3codex.com/api/topics/systemfiles/var-file.json"},{"slug":"systemfiles/vi-dump-file","title":"vi.dump file","category":"System Files","categorySlug":"systemfiles","summary":"The vi.dump file is created and used by the verify-index process as a temporary work file. It is created as a DX-pointer, so it is not saved during backup.","url":"https://d3codex.com/systemfiles/vi-dump-file/","api":"https://d3codex.com/api/topics/systemfiles/vi-dump-file.json"},{"slug":"systemfiles/words-file","title":"words file","category":"System Files","categorySlug":"systemfiles","summary":"The words file contains all the valid words used by the Update processor spelling checker. This file resides on the dm account. An index must be created for attribute 0 of the words file in order to activate the spelling checker.","url":"https://d3codex.com/systemfiles/words-file/","api":"https://d3codex.com/api/topics/systemfiles/words-file.json"},{"slug":"systemfiles/wsym-file","title":"wsym file","category":"System Files","categorySlug":"systemfiles","summary":"The wsym file, used by the x option of the op command, contains the results of counting each word in a document, along with the page number and line number of each word.","url":"https://d3codex.com/systemfiles/wsym-file/","api":"https://d3codex.com/api/topics/systemfiles/wsym-file.json"},{"slug":"systemfiles/xp-file","title":"xp file","category":"System Files","categorySlug":"systemfiles","summary":"The xp file contains the BASIC subroutines for extended precision arithmetic.","url":"https://d3codex.com/systemfiles/xp-file/","api":"https://d3codex.com/api/topics/systemfiles/xp-file.json"},{"slug":"systemfiles/zcf-file","title":"zcf file","category":"System Files","categorySlug":"systemfiles","summary":"The zcf file (zip code) is used as part of the zip code processing code.","url":"https://d3codex.com/systemfiles/zcf-file/","api":"https://d3codex.com/api/topics/systemfiles/zcf-file.json"},{"slug":"tcl/abs-dump-command","title":"abs-dump command","category":"TCL","categorySlug":"tcl","summary":"The abs-dump BASIC program dumps the abs file to magnetic media, creating a bootable tape.","url":"https://d3codex.com/tcl/abs-dump-command/","api":"https://d3codex.com/api/topics/tcl/abs-dump-command.json"},{"slug":"tcl/abs-fid-command","title":"abs.fid command","category":"TCL","categorySlug":"tcl","summary":"The abs.fid command displays the ABS information.","url":"https://d3codex.com/tcl/abs-fid-command/","api":"https://d3codex.com/api/topics/tcl/abs-fid-command.json"},{"slug":"tcl/account-coldstart-macro","title":"account-coldstart macro","category":"TCL","categorySlug":"tcl","summary":"The account-coldstart macro performs any account specific coldstart processes and allows users to define their own custom sequence of activities to perform each time the system is powered on or rebooted.","url":"https://d3codex.com/tcl/account-coldstart-macro/","api":"https://d3codex.com/api/topics/tcl/account-coldstart-macro.json"},{"slug":"tcl/account-maint-command","title":"account-maint command","category":"TCL","categorySlug":"tcl","summary":"The account-maint command invokes a menu to create, modify, or delete user accounts.","url":"https://d3codex.com/tcl/account-maint-command/","api":"https://d3codex.com/api/topics/tcl/account-maint-command.json"},{"slug":"tcl/account-restore-command","title":"account-restore command","category":"TCL","categorySlug":"tcl","summary":"The account-restore BASIC program restores an account from an account-save, file-save, or md-save magnetic media or pseudo tape.","url":"https://d3codex.com/tcl/account-restore-command/","api":"https://d3codex.com/api/topics/tcl/account-restore-command.json"},{"slug":"tcl/account-save-command","title":"account-save command","category":"TCL","categorySlug":"tcl","summary":"The account-save BASIC program saves individual accounts to the currently attached peripheral storage device. File statistics are built with each save, including an account-save and a dummy save, contrary to VME file statistics. The s option is no longer necessary.","url":"https://d3codex.com/tcl/account-save-command/","api":"https://d3codex.com/api/topics/tcl/account-save-command.json"},{"slug":"tcl/add-command","title":"add command","category":"TCL","categorySlug":"tcl","summary":"The add command adds two integer numbers together and displays the result as an integer number.","url":"https://d3codex.com/tcl/add-command/","api":"https://d3codex.com/api/topics/tcl/add-command.json"},{"slug":"tcl/addbi-command","title":"addbi command","category":"TCL","categorySlug":"tcl","summary":"The addbi command extends the functionality of the D3 monitor by making new C functions available to FlashBASIC.","url":"https://d3codex.com/tcl/addbi-command/","api":"https://d3codex.com/api/topics/tcl/addbi-command.json"},{"slug":"tcl/addx-command","title":"addx command","category":"TCL","categorySlug":"tcl","summary":"The addx command adds two hexadecimal numbers and displays the result as a hexadecimal number.","url":"https://d3codex.com/tcl/addx-command/","api":"https://d3codex.com/api/topics/tcl/addx-command.json"},{"slug":"tcl/admin-files-utility","title":"admin.files utility","category":"TCL","categorySlug":"tcl","summary":"The admin.files menu is for data backup and restore.","url":"https://d3codex.com/tcl/admin-files-utility/","api":"https://d3codex.com/api/topics/tcl/admin-files-utility.json"},{"slug":"tcl/admin-maint-utility","title":"admin.maint utility","category":"TCL","categorySlug":"tcl","summary":"The admin.maint menu is used for creating and maintaining users and accounts.","url":"https://d3codex.com/tcl/admin-maint-utility/","api":"https://d3codex.com/api/topics/tcl/admin-maint-utility.json"},{"slug":"tcl/admin-status-utility","title":"admin.status utility","category":"TCL","categorySlug":"tcl","summary":"The admin.status menu provides information on the users that are logged on to the system as well as reporting the status of the system lock table.","url":"https://d3codex.com/tcl/admin-status-utility/","api":"https://d3codex.com/api/topics/tcl/admin-status-utility.json"},{"slug":"tcl/admin-tape-setup-utility","title":"admin.tape.setup utility","category":"TCL","categorySlug":"tcl","summary":"The admin.tape.setup menu assigns the various tape devices for use.","url":"https://d3codex.com/tcl/admin-tape-setup-utility/","api":"https://d3codex.com/api/topics/tcl/admin-tape-setup-utility.json"},{"slug":"tcl/admin-tape-utility","title":"admin.tape utility","category":"TCL","categorySlug":"tcl","summary":"The admin.tape menu contains options to list the devices as well as commands to set up tape devices for usage.","url":"https://d3codex.com/tcl/admin-tape-utility/","api":"https://d3codex.com/api/topics/tcl/admin-tape-utility.json"},{"slug":"tcl/admin-utility","title":"admin utility","category":"TCL","categorySlug":"tcl","summary":"The admin menu contains systems administration functions and must be invoked from the dm account.","url":"https://d3codex.com/tcl/admin-utility/","api":"https://d3codex.com/api/topics/tcl/admin-utility.json"},{"slug":"tcl/alarm-command","title":"alarm command","category":"TCL","categorySlug":"tcl","summary":"The alarm BASIC program schedules a task at a given time, or after a given delay in seconds, at a given date.","url":"https://d3codex.com/tcl/alarm-command/","api":"https://d3codex.com/api/topics/tcl/alarm-command.json"},{"slug":"tcl/archive-accounts-command","title":"archive-accounts command","category":"TCL","categorySlug":"tcl","summary":"The archive-accounts command moves entries from the accounts data level to an archive data level, or optionally deletes them.","url":"https://d3codex.com/tcl/archive-accounts-command/","api":"https://d3codex.com/api/topics/tcl/archive-accounts-command.json"},{"slug":"tcl/assignfq-unix-command","title":"assignfq (UNIX) command","category":"TCL","categorySlug":"tcl","summary":"The assignfq command assigns a printer device driver to a spooler form queue. This printer driver is then used by the Output processor, or by FlashBASIC @() functions to generate special formatting commands such as boldface, cursor positioning, or underlining, when output is directed to the spooler.","url":"https://d3codex.com/tcl/assignfq-unix-command/","api":"https://d3codex.com/api/topics/tcl/assignfq-unix-command.json"},{"slug":"tcl/assignfq-windows-command","title":"assignfq (Windows) command","category":"TCL","categorySlug":"tcl","summary":"The assignfq command assigns a printer device driver to a spooler form queue. This printer driver is then used by the Output processor, or by FlashBASIC @() functions to generate special formatting commands such as boldface, cursor positioning, or underlining, when output is directed to the spooler.","url":"https://d3codex.com/tcl/assignfq-windows-command/","api":"https://d3codex.com/api/topics/tcl/assignfq-windows-command.json"},{"slug":"tcl/auto-disconnect-command","title":"auto-disconnect command","category":"TCL","categorySlug":"tcl","summary":"The auto-disconnect command allows certain clients the capability to disconnect from the server with a custom delay, reserving the line for reconnect.","url":"https://d3codex.com/tcl/auto-disconnect-command/","api":"https://d3codex.com/api/topics/tcl/auto-disconnect-command.json"},{"slug":"tcl/auto-restart-command","title":"auto-restart command","category":"TCL","categorySlug":"tcl","summary":"The auto-restart command allows the user to specify or clear a command that is executed whenever a D3 process is attempting to go to TCL.","url":"https://d3codex.com/tcl/auto-restart-command/","api":"https://d3codex.com/api/topics/tcl/auto-restart-command.json"},{"slug":"tcl/aux-off-command","title":"aux-off command","category":"TCL","categorySlug":"tcl","summary":"For mvBase users: The aux-off TCL command disables spooling previously defined by the aux-on TCL command.","url":"https://d3codex.com/tcl/aux-off-command/","api":"https://d3codex.com/api/topics/tcl/aux-off-command.json"},{"slug":"tcl/aux-on-command","title":"aux-on command","category":"TCL","categorySlug":"tcl","summary":"For mvBase users: mvBase supports auxiliary printers defined via the aux-on TCL command.","url":"https://d3codex.com/tcl/aux-on-command/","api":"https://d3codex.com/api/topics/tcl/aux-on-command.json"},{"slug":"tcl/b-list-command","title":"b/list command","category":"TCL","categorySlug":"tcl","summary":"The b/list BASIC program formats and outputs BASIC source code listings. It can also be used to format a BASIC source program and write it back to the file from which it came.","url":"https://d3codex.com/tcl/b-list-command/","api":"https://d3codex.com/api/topics/tcl/b-list-command.json"},{"slug":"tcl/basic-command","title":"basic command","category":"TCL","categorySlug":"tcl","summary":"The basic BASIC program invokes the BASIC and/or FlashBASIC compiler, which translates the specified source code into executable object code with case-sensitivity in effect. This causes the compiler to only accept uppercase keywords.","url":"https://d3codex.com/tcl/basic-command/","api":"https://d3codex.com/api/topics/tcl/basic-command.json"},{"slug":"tcl/basic-prot-command","title":"basic-prot command","category":"TCL","categorySlug":"tcl","summary":"The basic-prot command toggles or displays the status of the FlashBASIC object protection scheme.","url":"https://d3codex.com/tcl/basic-prot-command/","api":"https://d3codex.com/api/topics/tcl/basic-prot-command.json"},{"slug":"tcl/bformat-command","title":"bformat command","category":"TCL","categorySlug":"tcl","summary":"The bformat command formats a BASIC source program and updates the source file with the formatted item.","url":"https://d3codex.com/tcl/bformat-command/","api":"https://d3codex.com/api/topics/tcl/bformat-command.json"},{"slug":"tcl/blist-command","title":"blist command","category":"TCL","categorySlug":"tcl","summary":"The blist command formats and outputs BASIC source code listings, according to the options chosen. It can also be used to format a BASIC source program and write it back to the file from which it came.","url":"https://d3codex.com/tcl/blist-command/","api":"https://d3codex.com/api/topics/tcl/blist-command.json"},{"slug":"tcl/blkio-command","title":"blkio command","category":"TCL","categorySlug":"tcl","summary":"The blkio BASIC program displays or sets the I/O blocking factor, or number of frames read in one disk access during sequential file accesses. The setting is global for the whole system, and can be changed at any time.","url":"https://d3codex.com/tcl/blkio-command/","api":"https://d3codex.com/api/topics/tcl/blkio-command.json"},{"slug":"tcl/block-print-command","title":"block-print command","category":"TCL","categorySlug":"tcl","summary":"The block-print command produces a banner by converting characters to a large block format, made up of rows and columns of the character itself.","url":"https://d3codex.com/tcl/block-print-command/","api":"https://d3codex.com/api/topics/tcl/block-print-command.json"},{"slug":"tcl/bootstrap-command","title":"bootstrap command","category":"TCL","categorySlug":"tcl","summary":"The bootstrap BASIC program reloads the D3 operating system software from a currently executing system and then invokes the coldstart procedure.","url":"https://d3codex.com/tcl/bootstrap-command/","api":"https://d3codex.com/api/topics/tcl/bootstrap-command.json"},{"slug":"tcl/branching","title":"Branching","category":"TCL","categorySlug":"tcl","summary":"For conditional branching, the if-then-go construct is used.","url":"https://d3codex.com/tcl/branching/","api":"https://d3codex.com/api/topics/tcl/branching.json"},{"slug":"tcl/break-key","title":"BREAK key","category":"TCL","categorySlug":"tcl","summary":"While a system process is running, it remains in control of your terminal. Typically, you want the system process to complete its work and return control to the TCL level. If you press BREAK while a process is running, you will suspend the process and drop into a debugger.","url":"https://d3codex.com/tcl/break-key/","api":"https://d3codex.com/api/topics/tcl/break-key.json"},{"slug":"tcl/break-key-command","title":"break-key command","category":"TCL","categorySlug":"tcl","summary":"The break-key command toggles the availability of the BREAK key, or displays its present status when issued without options. If the PIB number is specified, the BREAK key status displays or is modified for the PIB number requested.","url":"https://d3codex.com/tcl/break-key-command/","api":"https://d3codex.com/api/topics/tcl/break-key-command.json"},{"slug":"tcl/break-key-off-macro","title":"break-key-off macro","category":"TCL","categorySlug":"tcl","summary":"The break-key-off macro disables the BREAK key on the current port. If the PIB number is specified, the BREAK key is disabled on the requested PIB number.","url":"https://d3codex.com/tcl/break-key-off-macro/","api":"https://d3codex.com/api/topics/tcl/break-key-off-macro.json"},{"slug":"tcl/break-key-on-macro","title":"break-key-on macro","category":"TCL","categorySlug":"tcl","summary":"The break-key-on macro enables the BREAK key on the current port. If the PIB number is specified, the BREAK key is enabled on the requested port.","url":"https://d3codex.com/tcl/break-key-on-macro/","api":"https://d3codex.com/api/topics/tcl/break-key-on-macro.json"},{"slug":"tcl/brk-debug-command","title":"brk-debug command","category":"TCL","categorySlug":"tcl","summary":"The brk-debug command indicates that the BREAK key invokes the debugger on subsequent uses.","url":"https://d3codex.com/tcl/brk-debug-command/","api":"https://d3codex.com/api/topics/tcl/brk-debug-command.json"},{"slug":"tcl/brk-level-command","title":"brk-level command","category":"TCL","categorySlug":"tcl","summary":"The brk-level command causes the BREAK key to push a level on subsequent uses. It is not possible to push a level while at the TCL prompt. At least one character must be entered.","url":"https://d3codex.com/tcl/brk-level-command/","api":"https://d3codex.com/api/topics/tcl/brk-level-command.json"},{"slug":"tcl/buf-map-command","title":"buf-map command","category":"TCL","categorySlug":"tcl","summary":"The buf-map BASIC program displays a visual map of the file system, indicating which frames are currently being held in the RAM buffer area, and updates the display every few seconds.","url":"https://d3codex.com/tcl/buf-map-command/","api":"https://d3codex.com/api/topics/tcl/buf-map-command.json"},{"slug":"tcl/buffers-command","title":"buffers command","category":"TCL","categorySlug":"tcl","summary":"The buffers BASIC program displays a single snapshot of the status of memory-resident buffers. The loop (l) option repeats the display until voluntarily stopped.","url":"https://d3codex.com/tcl/buffers-command/","api":"https://d3codex.com/api/topics/tcl/buffers-command.json"},{"slug":"tcl/buffers-g-command","title":"buffers.g command","category":"TCL","categorySlug":"tcl","summary":"Used in conjunction with the buffers BASIC program, the buffers.g command produces a graphic histogram of buffer usage for a range of dates and times.","url":"https://d3codex.com/tcl/buffers-g-command/","api":"https://d3codex.com/api/topics/tcl/buffers-g-command.json"},{"slug":"tcl/bulletin-board-command","title":"bulletin.board command","category":"TCL","categorySlug":"tcl","summary":"The bulletin.board BASIC program prints bulletins from the bulletin file located in the dm account.","url":"https://d3codex.com/tcl/bulletin-board-command/","api":"https://d3codex.com/api/topics/tcl/bulletin-board-command.json"},{"slug":"tcl/cal-macro","title":"cal macro","category":"TCL","categorySlug":"tcl","summary":"The UNIX cal macro executes the UNIX cal command.","url":"https://d3codex.com/tcl/cal-macro/","api":"https://d3codex.com/api/topics/tcl/cal-macro.json"},{"slug":"tcl/callx-off-command","title":"callx-off command","category":"TCL","categorySlug":"tcl","summary":"The callx-off command disables callx triggers. This command is only available from the DM account.","url":"https://d3codex.com/tcl/callx-off-command/","api":"https://d3codex.com/api/topics/tcl/callx-off-command.json"},{"slug":"tcl/callx-on-command","title":"callx-on command","category":"TCL","categorySlug":"tcl","summary":"The callx-on command enables callx triggers. This command is only available from the DM account.","url":"https://d3codex.com/tcl/callx-on-command/","api":"https://d3codex.com/api/topics/tcl/callx-on-command.json"},{"slug":"tcl/capt-command","title":"capt command","category":"TCL","categorySlug":"tcl","summary":"The capt command enables or disables the capturing of every TCL command issued. When enabled, TCL commands are placed in the captcl file using the item-ID user-ID*port.number.","url":"https://d3codex.com/tcl/capt-command/","api":"https://d3codex.com/api/topics/tcl/capt-command.json"},{"slug":"tcl/capture-off-command","title":"capture-off command","category":"TCL","categorySlug":"tcl","summary":"The capture-off BASIC program disables the automatic capturing of TCL commands previously invoked with the capture-on command.","url":"https://d3codex.com/tcl/capture-off-command/","api":"https://d3codex.com/api/topics/tcl/capture-off-command.json"},{"slug":"tcl/capture-on-command","title":"capture-on command","category":"TCL","categorySlug":"tcl","summary":"The capture-on BASIC program enables the capturing of every TCL command issued. The captured output is placed in the captcl file using user-ID*port.number as the item-ID.","url":"https://d3codex.com/tcl/capture-on-command/","api":"https://d3codex.com/api/topics/tcl/capture-on-command.json"},{"slug":"tcl/case-command","title":"case command","category":"TCL","categorySlug":"tcl","summary":"The case command toggles case-sensitivity on the current port, or displays its present condition when used without options.","url":"https://d3codex.com/tcl/case-command/","api":"https://d3codex.com/api/topics/tcl/case-command.json"},{"slug":"tcl/case-file-command","title":"case-file command","category":"TCL","categorySlug":"tcl","summary":"The case-file BASIC program converts the case of items to either uppercase or lowercase.","url":"https://d3codex.com/tcl/case-file-command/","api":"https://d3codex.com/api/topics/tcl/case-file-command.json"},{"slug":"tcl/cat-command","title":"cat command","category":"TCL","categorySlug":"tcl","summary":"The cat BASIC program displays information about the size and location of BASIC object code.","url":"https://d3codex.com/tcl/cat-command/","api":"https://d3codex.com/api/topics/tcl/cat-command.json"},{"slug":"tcl/catalog-command","title":"catalog command","category":"TCL","categorySlug":"tcl","summary":"The catalog BASIC program creates an entry in the master dictionary of the current account, making the specified BASIC or BASIC program executable directly from the TCL prompt.","url":"https://d3codex.com/tcl/catalog-command/","api":"https://d3codex.com/api/topics/tcl/catalog-command.json"},{"slug":"tcl/cd-command","title":"cd command","category":"TCL","categorySlug":"tcl","summary":"The cd BASIC program changes the current working directory to the specified new directory. The new directory remains until the D3 process is disconnected (not logged off) or a new cd command is issued. If the new directory is omitted, the default home directory is selected.","url":"https://d3codex.com/tcl/cd-command/","api":"https://d3codex.com/api/topics/tcl/cd-command.json"},{"slug":"tcl/cdtr-on-command","title":"dtr-on command","category":"TCL","categorySlug":"tcl","summary":"The dtr-on command turns on data terminal ready on another port, or the current port if none is specified.","url":"https://d3codex.com/tcl/cdtr-on-command/","api":"https://d3codex.com/api/topics/tcl/cdtr-on-command.json"},{"slug":"tcl/change-file-command","title":"change-file command","category":"TCL","categorySlug":"tcl","summary":"The change-file command changes the File Definition Code of a file.","url":"https://d3codex.com/tcl/change-file-command/","api":"https://d3codex.com/api/topics/tcl/change-file-command.json"},{"slug":"tcl/charge-to-command","title":"charge-to command","category":"TCL","categorySlug":"tcl","summary":"The charge-to command changes the current accounting charges accumulation.","url":"https://d3codex.com/tcl/charge-to-command/","api":"https://d3codex.com/api/topics/tcl/charge-to-command.json"},{"slug":"tcl/charges-command","title":"charges command","category":"TCL","categorySlug":"tcl","summary":"The charges command displays the current account usage statistics, including the total time logged on and CPU activity statistics.","url":"https://d3codex.com/tcl/charges-command/","api":"https://d3codex.com/api/topics/tcl/charges-command.json"},{"slug":"tcl/check-account-macro","title":"check-account macro","category":"TCL","categorySlug":"tcl","summary":"The check-account macro performs a dummy save of an account by issuing the save command with the f, d, and i options.","url":"https://d3codex.com/tcl/check-account-macro/","api":"https://d3codex.com/api/topics/tcl/check-account-macro.json"},{"slug":"tcl/check-dx-command","title":"check-dx command","category":"TCL","categorySlug":"tcl","summary":"The check-dx BASIC program looks through every file on the system to find and identify those that have a dx, dy, or dl in attribute 1 of the D-pointer. The dx and dy files are not saved by the save processor.","url":"https://d3codex.com/tcl/check-dx-command/","api":"https://d3codex.com/api/topics/tcl/check-dx-command.json"},{"slug":"tcl/check-file-command","title":"check-file command","category":"TCL","categorySlug":"tcl","summary":"The check-file command performs a consistency check on a file similar to that performed by the save command with the f, s, and t options.","url":"https://d3codex.com/tcl/check-file-command/","api":"https://d3codex.com/api/topics/tcl/check-file-command.json"},{"slug":"tcl/check-files-macro","title":"check-files macro","category":"TCL","categorySlug":"tcl","summary":"The check-files macro performs a dummy save of the entire system.","url":"https://d3codex.com/tcl/check-files-macro/","api":"https://d3codex.com/api/topics/tcl/check-files-macro.json"},{"slug":"tcl/check-pib-command","title":"check.pib command","category":"TCL","categorySlug":"tcl","summary":"The check.pib command displays the PIB information, such as PIB status, virtual return stack, workspace status, any basic programs being executed, as well as locks, peqs, files, items, connections and other objects being used by that PIB.","url":"https://d3codex.com/tcl/check-pib-command/","api":"https://d3codex.com/api/topics/tcl/check-pib-command.json"},{"slug":"tcl/check-resizing-command","title":"check-resizing command","category":"TCL","categorySlug":"tcl","summary":"The check-resizing BASIC program completes rehashing files in the process of being resized.","url":"https://d3codex.com/tcl/check-resizing-command/","api":"https://d3codex.com/api/topics/tcl/check-resizing-command.json"},{"slug":"tcl/check-ws-command","title":"check-ws command","category":"TCL","categorySlug":"tcl","summary":"The check-ws BASIC program validates the integrity of the workspace for a given port.","url":"https://d3codex.com/tcl/check-ws-command/","api":"https://d3codex.com/api/topics/tcl/check-ws-command.json"},{"slug":"tcl/chg-device-command","title":"chg-device command","category":"TCL","categorySlug":"tcl","summary":"The chg-device command changes a tape device. Devices that can be used as tapes are listed with the list-device command. Some characteristics can be changed to either modify the behavior of a device or to replace a device by another one. The changes made with this command are not permanent and are lost when the virtual machine is rebooted. If no option is specified, the current value is retained.","url":"https://d3codex.com/tcl/chg-device-command/","api":"https://d3codex.com/api/topics/tcl/chg-device-command.json"},{"slug":"tcl/chksum-command","title":"chksum command","category":"TCL","categorySlug":"tcl","summary":"The chksum command, in DM only, calculates a hexadecimal checksum for either an entire file or a list of items in the file, and outputs the results to a file.","url":"https://d3codex.com/tcl/chksum-command/","api":"https://d3codex.com/api/topics/tcl/chksum-command.json"},{"slug":"tcl/choose-term-command","title":"choose.term command","category":"TCL","categorySlug":"tcl","summary":"The choose.term BASIC program selects one of a variety of choices of terminal type characteristics as an alternative to using the term-type command.","url":"https://d3codex.com/tcl/choose-term-command/","api":"https://d3codex.com/api/topics/tcl/choose-term-command.json"},{"slug":"tcl/cleanpibs-command","title":"cleanpibs command","category":"TCL","categorySlug":"tcl","summary":"The cleanpibs BASIC program clears tandem connects for all ports logged on before port 0. This is used at coldstart time to make sure that any tandem information left over from a system crash does not get picked up.","url":"https://d3codex.com/tcl/cleanpibs-command/","api":"https://d3codex.com/api/topics/tcl/cleanpibs-command.json"},{"slug":"tcl/clear-basic-locks-macro","title":"clear-basic-locks macro","category":"TCL","categorySlug":"tcl","summary":"The clear-basic-locks macro displays and clears all 992 BASIC execution locks.","url":"https://d3codex.com/tcl/clear-basic-locks-macro/","api":"https://d3codex.com/api/topics/tcl/clear-basic-locks-macro.json"},{"slug":"tcl/clear-file-command","title":"clear-file command","category":"TCL","categorySlug":"tcl","summary":"The clear-file command clears the dictionary or data section of the specified file of all items and retains the primary file space area.","url":"https://d3codex.com/tcl/clear-file-command/","api":"https://d3codex.com/api/topics/tcl/clear-file-command.json"},{"slug":"tcl/clear-group-locks-command","title":"clear-group-locks command","category":"TCL","categorySlug":"tcl","summary":"The clear-group-locks command clears the group locks in the system group locks table.","url":"https://d3codex.com/tcl/clear-group-locks-command/","api":"https://d3codex.com/api/topics/tcl/clear-group-locks-command.json"},{"slug":"tcl/clear-index-command","title":"clear-index command","category":"TCL","categorySlug":"tcl","summary":"The clear-index command clears the specified B-tree index expression in the specified file, leaving only a null root. This command is not supported in the FSI.","url":"https://d3codex.com/tcl/clear-index-command/","api":"https://d3codex.com/api/topics/tcl/clear-index-command.json"},{"slug":"tcl/clear-jobs-command","title":"clear-jobs command","category":"TCL","categorySlug":"tcl","summary":"The clear-jobs command selects items with the status logoff or completed, and deletes them from the dm,jobs, file.","url":"https://d3codex.com/tcl/clear-jobs-command/","api":"https://d3codex.com/api/topics/tcl/clear-jobs-command.json"},{"slug":"tcl/clear-locks-command","title":"clear-locks command","category":"TCL","categorySlug":"tcl","summary":"The clear-locks BASIC program clears all locks, or specific locks, according to the options provided. When used with the i option, an optional host can be specified to release all item locks residing on a remote server.","url":"https://d3codex.com/tcl/clear-locks-command/","api":"https://d3codex.com/api/topics/tcl/clear-locks-command.json"},{"slug":"tcl/cls-command","title":"cls command","category":"TCL","categorySlug":"tcl","summary":"The cls command clears the screen, leaving the cursor at the : prompt at the bottom of the screen.","url":"https://d3codex.com/tcl/cls-command/","api":"https://d3codex.com/api/topics/tcl/cls-command.json"},{"slug":"tcl/cmdu-command","title":"cmdu command","category":"TCL","categorySlug":"tcl","summary":"The cmdu command from DM produces a report of the last TCL command issued by every active user on the system.","url":"https://d3codex.com/tcl/cmdu-command/","api":"https://d3codex.com/api/topics/tcl/cmdu-command.json"},{"slug":"tcl/coldstart-accounts-command","title":"coldstart-accounts command","category":"TCL","categorySlug":"tcl","summary":"The coldstart-accounts command is invoked by the coldstart to call the account-coldstart macro.","url":"https://d3codex.com/tcl/coldstart-accounts-command/","api":"https://d3codex.com/api/topics/tcl/coldstart-accounts-command.json"},{"slug":"tcl/coldstart-command","title":"coldstart command","category":"TCL","categorySlug":"tcl","summary":"The coldstart command initiates the sequence of activities that must be performed each time the system is powered on. Additionally, the coldstart command initializes the transaction log queue limit to 0 on a full restore and during a patch installation.","url":"https://d3codex.com/tcl/coldstart-command/","api":"https://d3codex.com/api/topics/tcl/coldstart-command.json"},{"slug":"tcl/coldstart-log-command","title":"coldstart.log command","category":"TCL","categorySlug":"tcl","summary":"The coldstart.log command records the type of shutdown taking place into the errors file.","url":"https://d3codex.com/tcl/coldstart-log-command/","api":"https://d3codex.com/api/topics/tcl/coldstart-log-command.json"},{"slug":"tcl/colon-files-command","title":":files command","category":"TCL","categorySlug":"tcl","summary":"UNIX Only: The :files command restores the entire file system from file-save media.","url":"https://d3codex.com/tcl/colon-files-command/","api":"https://d3codex.com/api/topics/tcl/colon-files-command.json"},{"slug":"tcl/colon-reset-async-command","title":":reset-async command","category":"TCL","categorySlug":"tcl","summary":"The :reset-async BASIC program resets the current port or all ports to default values.","url":"https://d3codex.com/tcl/colon-reset-async-command/","api":"https://d3codex.com/api/topics/tcl/colon-reset-async-command.json"},{"slug":"tcl/colon-scroll-command","title":":scroll command","category":"TCL","categorySlug":"tcl","summary":"The :scroll BASIC program displays the output of a TCL command in a scrollable (text) window.","url":"https://d3codex.com/tcl/colon-scroll-command/","api":"https://d3codex.com/api/topics/tcl/colon-scroll-command.json"},{"slug":"tcl/comment-statement","title":"comment statement","category":"TCL","categorySlug":"tcl","summary":"The comment statement performs cursor control and screen display commands in a macro is similar to the t statement in a PROC. Its primary function is to add screen control capabilities to macro commands.","url":"https://d3codex.com/tcl/comment-statement/","api":"https://d3codex.com/api/topics/tcl/comment-statement.json"},{"slug":"tcl/comments","title":"Comments","category":"TCL","categorySlug":"tcl","summary":"Any line beginning with an asterisk is assumed to be a comment. For example, *comment.","url":"https://d3codex.com/tcl/comments/","api":"https://d3codex.com/api/topics/tcl/comments.json"},{"slug":"tcl/compare-command","title":"compare command","category":"TCL","categorySlug":"tcl","summary":"The compare command compares items line-by-line to find which lines have been inserted, deleted or changed.","url":"https://d3codex.com/tcl/compare-command/","api":"https://d3codex.com/api/topics/tcl/compare-command.json"},{"slug":"tcl/compare-list-command","title":"compare-list command","category":"TCL","categorySlug":"tcl","summary":"The compare-list BASIC program forms a single list from two lists using the intersection, union, or exclusion operators.","url":"https://d3codex.com/tcl/compare-list-command/","api":"https://d3codex.com/api/topics/tcl/compare-list-command.json"},{"slug":"tcl/compile-catalog-command","title":"compile-catalog command","category":"TCL","categorySlug":"tcl","summary":"The compile-catalog BASIC program (CTRL+XC from within the Update processor) compiles and catalogs a BASIC program.","url":"https://d3codex.com/tcl/compile-catalog-command/","api":"https://d3codex.com/api/topics/tcl/compile-catalog-command.json"},{"slug":"tcl/compile-command","title":"compile command","category":"TCL","categorySlug":"tcl","summary":"The compile BASIC program invokes the BASIC compiler and translates the specified source code into executable object code with case insensitivity.","url":"https://d3codex.com/tcl/compile-command/","api":"https://d3codex.com/api/topics/tcl/compile-command.json"},{"slug":"tcl/compile-flash-all-command","title":"compile.flash.all command","category":"TCL","categorySlug":"tcl","summary":"The compile.flash.all command allows you to compile all BASIC programs currently compiled with FlashBASIC, either in one or all accounts on the system. The result is platform independent, optimized object code that does not require the existence of a C compiler.","url":"https://d3codex.com/tcl/compile-flash-all-command/","api":"https://d3codex.com/api/topics/tcl/compile-flash-all-command.json"},{"slug":"tcl/compile-run-command","title":"compile-run command","category":"TCL","categorySlug":"tcl","summary":"The compile-run BASIC program (CTRL+XR from within the Update processor) compiles and runs a BASIC program.","url":"https://d3codex.com/tcl/compile-run-command/","api":"https://d3codex.com/api/topics/tcl/compile-run-command.json"},{"slug":"tcl/configuring-a-windows-printer-for-the-windows-gdi-driver","title":"Configuring a Windows printer for the Windows GDI driver","category":"TCL","categorySlug":"tcl","summary":"Configuring a Windows printer for the Windows GDI Driver entails creating the Windows printer device and then associating a spooler assignment with the Windows printer control item in the DEVICES file.","url":"https://d3codex.com/tcl/configuring-a-windows-printer-for-the-windows-gdi-driver/","api":"https://d3codex.com/api/topics/tcl/configuring-a-windows-printer-for-the-windows-gdi-driver.json"},{"slug":"tcl/console-blank-command","title":"console-blank command","category":"TCL","categorySlug":"tcl","summary":"The console-blank BASIC program from the DM account sets the blank out time or turn off the blank out feature.","url":"https://d3codex.com/tcl/console-blank-command/","api":"https://d3codex.com/api/topics/tcl/console-blank-command.json"},{"slug":"tcl/control-chars-command","title":"control-chars command","category":"TCL","categorySlug":"tcl","summary":"The control-chars command enables or disables the entering of control characters at input, depending on the option specified.","url":"https://d3codex.com/tcl/control-chars-command/","api":"https://d3codex.com/api/topics/tcl/control-chars-command.json"},{"slug":"tcl/conv-case-command","title":"conv-case command","category":"TCL","categorySlug":"tcl","summary":"The conv-case BASIC program converts the characters within specified items plus the item-ID to uppercase or lowercase, according to the options provided.","url":"https://d3codex.com/tcl/conv-case-command/","api":"https://d3codex.com/api/topics/tcl/conv-case-command.json"},{"slug":"tcl/converse-command","title":"converse command","category":"TCL","categorySlug":"tcl","summary":"The converse BASIC program links the current process to a device. The target or slave device is put into a pass-through mode, allowing data in and out in raw mode.","url":"https://d3codex.com/tcl/converse-command/","api":"https://d3codex.com/api/topics/tcl/converse-command.json"},{"slug":"tcl/copy-command","title":"copy command","category":"TCL","categorySlug":"tcl","summary":"The copy command copies items to an output device, to another item-ID, or to another file.","url":"https://d3codex.com/tcl/copy-command/","api":"https://d3codex.com/api/topics/tcl/copy-command.json"},{"slug":"tcl/copy-list-command","title":"copy-list command","category":"TCL","categorySlug":"tcl","summary":"The copy-list command copies a saved list to either a new item-ID, a new file reference, or to the specified output device.","url":"https://d3codex.com/tcl/copy-list-command/","api":"https://d3codex.com/api/topics/tcl/copy-list-command.json"},{"slug":"tcl/cp-command","title":"cp command","category":"TCL","categorySlug":"tcl","summary":"The cp BASIC program copies the specified items to the printer via the spooler.","url":"https://d3codex.com/tcl/cp-command/","api":"https://d3codex.com/api/topics/tcl/cp-command.json"},{"slug":"tcl/create-abs-command","title":"create-abs command","category":"TCL","categorySlug":"tcl","summary":"The create-abs command sets aside a contiguous set of frames as the destination for loading the ABS code (the D3 virtual code). This space is called the ABS area.","url":"https://d3codex.com/tcl/create-abs-command/","api":"https://d3codex.com/api/topics/tcl/create-abs-command.json"},{"slug":"tcl/create-account-command","title":"create-account command","category":"TCL","categorySlug":"tcl","summary":"The create-account BASIC program creates a new master dictionary, copies all the necessary items into it, and updates the mds file with the name and address.","url":"https://d3codex.com/tcl/create-account-command/","api":"https://d3codex.com/api/topics/tcl/create-account-command.json"},{"slug":"tcl/create-file-command","title":"create-file command","category":"TCL","categorySlug":"tcl","summary":"The create-file BASIC program creates a new dictionary and data file, a dictionary-only file, or a new data section on an existing dictionary file; space is allocated and reserved if available.","url":"https://d3codex.com/tcl/create-file-command/","api":"https://d3codex.com/api/topics/tcl/create-file-command.json"},{"slug":"tcl/create-index-command","title":"create-index command","category":"TCL","categorySlug":"tcl","summary":"The create-index BASIC program creates a new B-tree index in the specified file using the a (algebraic) processing code expression provided and ensures the a0 index case-sensitivity matches the item-ID case sensitivity.","url":"https://d3codex.com/tcl/create-index-command/","api":"https://d3codex.com/api/topics/tcl/create-index-command.json"},{"slug":"tcl/create-macro-command","title":"create-macro command","category":"TCL","categorySlug":"tcl","summary":"The create-macro BASIC program creates an executable macro from the last TCL command entered and places the macro in the master dictionary of the current account.","url":"https://d3codex.com/tcl/create-macro-command/","api":"https://d3codex.com/api/topics/tcl/create-macro-command.json"},{"slug":"tcl/create-nqptrs-command","title":"create-nqptrs command","category":"TCL","categorySlug":"tcl","summary":"The create-nqptrs command in DM builds a Q-pointer for each D-pointer file in the dm account and adds them to the dm,newac, file.","url":"https://d3codex.com/tcl/create-nqptrs-command/","api":"https://d3codex.com/api/topics/tcl/create-nqptrs-command.json"},{"slug":"tcl/crt-delimiters-command","title":"crt-delimiters command","category":"TCL","categorySlug":"tcl","summary":"The crt-delimiters command enables and disables the display of attribute and value marks. At boot time, the crt-delimiters command defaults to on. If the crt-delimiters command is executed without options, then it displays the current status.","url":"https://d3codex.com/tcl/crt-delimiters-command/","api":"https://d3codex.com/api/topics/tcl/crt-delimiters-command.json"},{"slug":"tcl/crt-device-command","title":"crt-device command","category":"TCL","categorySlug":"tcl","summary":"The crt-device command forces BASIC and FlashBASIC to use the CRT terminal device instead of the printer device for the @ functions with the printer in the ON state.","url":"https://d3codex.com/tcl/crt-device-command/","api":"https://d3codex.com/api/topics/tcl/crt-device-command.json"},{"slug":"tcl/ct-command","title":"ct command","category":"TCL","categorySlug":"tcl","summary":"The ct BASIC program invokes the copy command and copies the specified items to the terminal.","url":"https://d3codex.com/tcl/ct-command/","api":"https://d3codex.com/api/topics/tcl/ct-command.json"},{"slug":"tcl/cvtcpy-utility","title":"cvtcpy utility","category":"TCL","categorySlug":"tcl","summary":"The cvtcpy utility in the DM account copies a tape to another tape, including format and block conversions, and reads D3, CIE, Reality or Ultimate tape formats, with a block size up to 64 KB, and creates a D3 tape.","url":"https://d3codex.com/tcl/cvtcpy-utility/","api":"https://d3codex.com/api/topics/tcl/cvtcpy-utility.json"},{"slug":"tcl/d3tcl-command-windows","title":"D3Tcl command (Windows)","category":"TCL","categorySlug":"tcl","summary":"The D3Tcl command connects a remote VME with a TCL command from MS-DOS.","url":"https://d3codex.com/tcl/d3tcl-command-windows/","api":"https://d3codex.com/api/topics/tcl/d3tcl-command-windows.json"},{"slug":"tcl/data-stacking","title":"Data stacking","category":"TCL","categorySlug":"tcl","summary":"As in a macro, paragraphs can stack data by adding a second value after a command. Also, a separate line can display with the syntax:","url":"https://d3codex.com/tcl/data-stacking/","api":"https://d3codex.com/api/topics/tcl/data-stacking.json"},{"slug":"tcl/database-pause-command","title":"database-pause command","category":"TCL","categorySlug":"tcl","summary":"The database-pause command temporarily suspends disk writes to allow for external backups (or snapshots) of disks to be taken.","url":"https://d3codex.com/tcl/database-pause-command/","api":"https://d3codex.com/api/topics/tcl/database-pause-command.json"},{"slug":"tcl/database-resume-command-dita","title":"database-resume command","category":"TCL","categorySlug":"tcl","summary":"The database-resume command resumes database disk writes when a database-pause condition is in effect.","url":"https://d3codex.com/tcl/database-resume-command-dita/","api":"https://d3codex.com/api/topics/tcl/database-resume-command-dita.json"},{"slug":"tcl/date-command","title":"date command","category":"TCL","categorySlug":"tcl","summary":"The date BASIC program returns an internal, external, or Julian date derived from a date provided, or displays a calendar for the month and year of the date provided.","url":"https://d3codex.com/tcl/date-command/","api":"https://d3codex.com/api/topics/tcl/date-command.json"},{"slug":"tcl/dcd-command","title":"dcd command","category":"TCL","categorySlug":"tcl","summary":"The dcd BASIC program toggles or displays the status of data carrier detect on the specified port.","url":"https://d3codex.com/tcl/dcd-command/","api":"https://d3codex.com/api/topics/tcl/dcd-command.json"},{"slug":"tcl/debug-command-tcl-commands","title":"debug command (TCL commands)","category":"TCL","categorySlug":"tcl","summary":"The debug command enters the system debugger (if at TCL) or enters the BASIC/ debugger (if running a FlashBASIC program).","url":"https://d3codex.com/tcl/debug-command-tcl-commands/","api":"https://d3codex.com/api/topics/tcl/debug-command-tcl-commands.json"},{"slug":"tcl/decatalog-command","title":"decatalog command","category":"TCL","categorySlug":"tcl","summary":"The decatalog command removes the compiled BASIC or FlashBASIC object code of the specified items from the dictionary of the specified file, and removes the corresponding command entry (or entries) from the master dictionary of the current account.","url":"https://d3codex.com/tcl/decatalog-command/","api":"https://d3codex.com/api/topics/tcl/decatalog-command.json"},{"slug":"tcl/decrypt-file-command","title":"decrypt-file command","category":"TCL","categorySlug":"tcl","summary":"The decrypt-file command returns an encrypted file back to its original unencrypted format.","url":"https://d3codex.com/tcl/decrypt-file-command/","api":"https://d3codex.com/api/topics/tcl/decrypt-file-command.json"},{"slug":"tcl/default-font-management","title":"Default font management","category":"TCL","categorySlug":"tcl","summary":"The Sample.Windows.Printer item in the dm,devices, file is a printer device driver template that controls the behavior of the various @() functions associated with Windows GDI printing.","url":"https://d3codex.com/tcl/default-font-management/","api":"https://d3codex.com/api/topics/tcl/default-font-management.json"},{"slug":"tcl/define-cursor-command","title":"define-cursor command","category":"TCL","categorySlug":"tcl","summary":"For mvBase users: The define-cursor BASIC program displays the available terminal (driver) definitions, and allows the modification of existing definitions or the addition of new definitions.","url":"https://d3codex.com/tcl/define-cursor-command/","api":"https://d3codex.com/api/topics/tcl/define-cursor-command.json"},{"slug":"tcl/define-terminal-command","title":"define-terminal command","category":"TCL","categorySlug":"tcl","summary":"The define-terminal BASIC program displays the available terminal (driver) definitions, and allows the modification of existing definitions or the addition of new definitions.","url":"https://d3codex.com/tcl/define-terminal-command/","api":"https://d3codex.com/api/topics/tcl/define-terminal-command.json"},{"slug":"tcl/define-up-command","title":"define-up command","category":"TCL","categorySlug":"tcl","summary":"The define-up BASIC program provides a front-end for defining a keyboard for the Update processor. It builds a keyboard item that is used by the set-imap program to translate the keyboard keys entered into Update processor commands. It automatically detects whether the keyboard needs the extended character set enabled. After filing the item in the define-up program, then execute a set-imap terminal-name (c command to put the new translations into effect.","url":"https://d3codex.com/tcl/define-up-command/","api":"https://d3codex.com/api/topics/tcl/define-up-command.json"},{"slug":"tcl/delete-account-command","title":"delete-account command","category":"TCL","categorySlug":"tcl","summary":"The delete-account BASIC program deletes an entire account, and all the associated files, returning the space used to the overflow table and removing the account name from the mds file.","url":"https://d3codex.com/tcl/delete-account-command/","api":"https://d3codex.com/api/topics/tcl/delete-account-command.json"},{"slug":"tcl/delete-command","title":"delete command","category":"TCL","categorySlug":"tcl","summary":"The delete BASIC program deletes one or more items from the given file.","url":"https://d3codex.com/tcl/delete-command/","api":"https://d3codex.com/api/topics/tcl/delete-command.json"},{"slug":"tcl/delete-file-command","title":"delete-file command","category":"TCL","categorySlug":"tcl","summary":"The delete-file BASIC program releases all frames used by the specified file to the overflow table, and removes the file reference from the master dictionary of the current account.","url":"https://d3codex.com/tcl/delete-file-command/","api":"https://d3codex.com/api/topics/tcl/delete-file-command.json"},{"slug":"tcl/delete-index-command","title":"delete-index command","category":"TCL","categorySlug":"tcl","summary":"The delete-index BASIC program removes either a specific B-tree index from a specified file, or all indexes if an asterisk is specified.","url":"https://d3codex.com/tcl/delete-index-command/","api":"https://d3codex.com/api/topics/tcl/delete-index-command.json"},{"slug":"tcl/delete-list-command","title":"delete-list command","category":"TCL","categorySlug":"tcl","summary":"The delete-list command removes a list previously saved with a save-list command. This command deletes a list from a specified file name, otherwise it defaults to the pointer-file file. If no list name is provided, the default list name, %user-ID, is deleted.","url":"https://d3codex.com/tcl/delete-list-command/","api":"https://d3codex.com/api/topics/tcl/delete-list-command.json"},{"slug":"tcl/deoptimize-command","title":"deoptimize command","category":"TCL","categorySlug":"tcl","summary":"The deoptimize command removes the flash-compiled object code from the object code item, leaving the non-flash object code. This command may be used at a select prompt to deoptimize a select group of programs.","url":"https://d3codex.com/tcl/deoptimize-command/","api":"https://d3codex.com/api/topics/tcl/deoptimize-command.json"},{"slug":"tcl/dev-att-command","title":"dev-att command","category":"TCL","categorySlug":"tcl","summary":"The dev-att BASIC program attaches an unattached port to the current process. This command only changes ownership and is required prior to using the get or send statements in BASIC.","url":"https://d3codex.com/tcl/dev-att-command/","api":"https://d3codex.com/api/topics/tcl/dev-att-command.json"},{"slug":"tcl/dev-det-command","title":"dev-det command","category":"TCL","categorySlug":"tcl","summary":"The dev-det BASIC program detaches the port currently attached from the current process. The user gives up exclusive ownership of the port previously attached by the dev-att command and makes the port available to other users.","url":"https://d3codex.com/tcl/dev-det-command/","api":"https://d3codex.com/api/topics/tcl/dev-det-command.json"},{"slug":"tcl/dev-list-command","title":"dev-list command","category":"TCL","categorySlug":"tcl","summary":"The dev-list BASIC program lists all current devices on the system.","url":"https://d3codex.com/tcl/dev-list-command/","api":"https://d3codex.com/api/topics/tcl/dev-list-command.json"},{"slug":"tcl/dev-make-command-unix","title":"dev-make command (UNIX)","category":"TCL","categorySlug":"tcl","summary":"The dev-make BASIC program adds an entity to the system. This command is normally used to add devices to the system. The most common usage is to create a serial device to be used with the BASIC get and send statements, even if there is no D3 process connected to the device.","url":"https://d3codex.com/tcl/dev-make-command-unix/","api":"https://d3codex.com/api/topics/tcl/dev-make-command-unix.json"},{"slug":"tcl/dev-make-command-windows","title":"dev-make command (Windows)","category":"TCL","categorySlug":"tcl","summary":"The dev-make BASIC program creates devices connected to the VME. Devices can be removed with the dev-remov command.","url":"https://d3codex.com/tcl/dev-make-command-windows/","api":"https://d3codex.com/api/topics/tcl/dev-make-command-windows.json"},{"slug":"tcl/dev-remov-command","title":"dev-remov command","category":"TCL","categorySlug":"tcl","summary":"The dev-remov BASIC program removes a specific device from the system. This command is not allowed to remove special devices, such as the BB (byte bucket) or the CO (Console). Additionally, the dev-remov command prevents the removal of tape devices that are already attached or if a higher device number is already attached.","url":"https://d3codex.com/tcl/dev-remov-command/","api":"https://d3codex.com/api/topics/tcl/dev-remov-command.json"},{"slug":"tcl/diag-command","title":"diag command","category":"TCL","categorySlug":"tcl","summary":"The diag command invokes the internal system diagnostics utility.","url":"https://d3codex.com/tcl/diag-command/","api":"https://d3codex.com/api/topics/tcl/diag-command.json"},{"slug":"tcl/dialer-command","title":"dialer command","category":"TCL","categorySlug":"tcl","summary":"The dialer BASIC program controls the dialer subsystem, which allows transferring data to remote systems over the phone in a batch mode.","url":"https://d3codex.com/tcl/dialer-command/","api":"https://d3codex.com/api/topics/tcl/dialer-command.json"},{"slug":"tcl/dialer-copy-command","title":"dialer-copy command","category":"TCL","categorySlug":"tcl","summary":"The dialer-copy command queues one or more items for copy to a remote system through the dialer subsystem.","url":"https://d3codex.com/tcl/dialer-copy-command/","api":"https://d3codex.com/api/topics/tcl/dialer-copy-command.json"},{"slug":"tcl/disc-command","title":"disc command","category":"TCL","categorySlug":"tcl","summary":"The disc command disconnects the current process from the D3 virtual machine.","url":"https://d3codex.com/tcl/disc-command/","api":"https://d3codex.com/api/topics/tcl/disc-command.json"},{"slug":"tcl/display-statement","title":"display statement","category":"TCL","categorySlug":"tcl","summary":"The display statement outputs text on the screen in a macros or a Procs. If the message text is terminated by a +, the trailing carriage return is suppressed.","url":"https://d3codex.com/tcl/display-statement/","api":"https://d3codex.com/api/topics/tcl/display-statement.json"},{"slug":"tcl/div-command","title":"div command","category":"TCL","categorySlug":"tcl","summary":"The div command divides the first integer number provided by the second integer number provided and displays the result as an integer quotient and remainder.","url":"https://d3codex.com/tcl/div-command/","api":"https://d3codex.com/api/topics/tcl/div-command.json"},{"slug":"tcl/divx-command","title":"divx command","category":"TCL","categorySlug":"tcl","summary":"The divx command divides the first hexadecimal number by the second hexadecimal number and displays the result as a hexadecimal quotient and remainder.","url":"https://d3codex.com/tcl/divx-command/","api":"https://d3codex.com/api/topics/tcl/divx-command.json"},{"slug":"tcl/dm-macro","title":"dm macro","category":"TCL","categorySlug":"tcl","summary":"The dm logon macro for the Data Manager account, issues an exec abs command each time a user logs on to the dm account.","url":"https://d3codex.com/tcl/dm-macro/","api":"https://d3codex.com/api/topics/tcl/dm-macro.json"},{"slug":"tcl/dot-stack","title":"Dot stack","category":"TCL","categorySlug":"tcl","summary":"The dot stack displays the entries entered at TCL. Every unique command that is typed at the TCL prompt is saved in a file on the dm account called tcl-stack.","url":"https://d3codex.com/tcl/dot-stack/","api":"https://d3codex.com/api/topics/tcl/dot-stack.json"},{"slug":"tcl/download-command","title":"download command","category":"TCL","categorySlug":"tcl","summary":"The download BASIC program downloads font files to a laser printer.","url":"https://d3codex.com/tcl/download-command/","api":"https://d3codex.com/api/topics/tcl/download-command.json"},{"slug":"tcl/dtr-off-command","title":"dtr-off command","category":"TCL","categorySlug":"tcl","summary":"The dtr-off macro turns off data terminal ready.","url":"https://d3codex.com/tcl/dtr-off-command/","api":"https://d3codex.com/api/topics/tcl/dtr-off-command.json"},{"slug":"tcl/dtx-command","title":"dtx command","category":"TCL","categorySlug":"tcl","summary":"The dtx command converts a given decimal (integer) number to its corresponding hexadecimal equivalent.","url":"https://d3codex.com/tcl/dtx-command/","api":"https://d3codex.com/api/topics/tcl/dtx-command.json"},{"slug":"tcl/dummy-restore","title":"Dummy restore","category":"TCL","categorySlug":"tcl","summary":"The dummy restore is a method of validating that the save-type (account-save, file-save, and so on) backup are restored.","url":"https://d3codex.com/tcl/dummy-restore/","api":"https://d3codex.com/api/topics/tcl/dummy-restore.json"},{"slug":"tcl/dummy-save","title":"Dummy save","category":"TCL","categorySlug":"tcl","summary":"The dummy save performs the save command without actually writing to magnetic media.","url":"https://d3codex.com/tcl/dummy-save/","api":"https://d3codex.com/api/topics/tcl/dummy-save.json"},{"slug":"tcl/dump-command","title":"dump command","category":"TCL","categorySlug":"tcl","summary":"The dump command displays or prints the contents of one or more frames of the VME in ASCII (character), EBCDIC or hexadecimal format.","url":"https://d3codex.com/tcl/dump-command/","api":"https://d3codex.com/api/topics/tcl/dump-command.json"},{"slug":"tcl/echo-command","title":"echo command","category":"TCL","categorySlug":"tcl","summary":"The echo command turns terminal character echo on or off. When terminal echo is off, characters entered from the keyboard are not displayed on the terminal screen.","url":"https://d3codex.com/tcl/echo-command/","api":"https://d3codex.com/api/topics/tcl/echo-command.json"},{"slug":"tcl/edit-command-tcl-commands","title":"edit command (TCL commands)","category":"TCL","categorySlug":"tcl","summary":"The edit command invokes the line editor for entry or update of any item in the system (that is, BASIC programs, Procs, data items, and so on).","url":"https://d3codex.com/tcl/edit-command-tcl-commands/","api":"https://d3codex.com/api/topics/tcl/edit-command-tcl-commands.json"},{"slug":"tcl/edit-list-command","title":"edit-list command","category":"TCL","categorySlug":"tcl","summary":"The edit-list BASIC program retrieves a previously saved list and enters the line editor (same as ed or edit). Each element in the list is treated as a line by the line editor; all of the line editor edit commands are valid. For using the Update processor to update saved lists.","url":"https://d3codex.com/tcl/edit-list-command/","api":"https://d3codex.com/api/topics/tcl/edit-list-command.json"},{"slug":"tcl/editing-tcl-commands","title":"Editing TCL commands","category":"TCL","categorySlug":"tcl","summary":"The TCL editor uses the Update processor to enter commands, so the TCL editor commands are similar to the Update processor commands. A TCL command may be created and edited as if it were a paragraph. Pressing CTRL+M or Enter within the TCL command processes the entry.","url":"https://d3codex.com/tcl/editing-tcl-commands/","api":"https://d3codex.com/api/topics/tcl/editing-tcl-commands.json"},{"slug":"tcl/encrypt-file-command","title":"encrypt-file command","category":"TCL","categorySlug":"tcl","summary":"The encrypt-file command encrypts data in a specified file.","url":"https://d3codex.com/tcl/encrypt-file-command/","api":"https://d3codex.com/api/topics/tcl/encrypt-file-command.json"},{"slug":"tcl/end-command-tcl-commands","title":"end command (TCL commands)","category":"TCL","categorySlug":"tcl","summary":"The end command terminates a process on another port, or the current port if a port number is not specified.","url":"https://d3codex.com/tcl/end-command-tcl-commands/","api":"https://d3codex.com/api/topics/tcl/end-command-tcl-commands.json"},{"slug":"tcl/enqueue-status-command","title":"enqueue-status command","category":"TCL","categorySlug":"tcl","summary":"The enqueue-status command displays information about the state of the local transaction logging disabled flag for either a specified line or all lines currently logged on.","url":"https://d3codex.com/tcl/enqueue-status-command/","api":"https://d3codex.com/api/topics/tcl/enqueue-status-command.json"},{"slug":"tcl/environ-command","title":"environ command","category":"TCL","categorySlug":"tcl","summary":"The environ command manipulates the UNIX shell environment variables from TCL.","url":"https://d3codex.com/tcl/environ-command/","api":"https://d3codex.com/api/topics/tcl/environ-command.json"},{"slug":"tcl/esc-data-command","title":"esc-data command","category":"TCL","categorySlug":"tcl","summary":"The esc-data BASIC program specifies that the code generated by pressing ESC (control [) is to be passed through as data.","url":"https://d3codex.com/tcl/esc-data-command/","api":"https://d3codex.com/api/topics/tcl/esc-data-command.json"},{"slug":"tcl/esc-level-command","title":"esc-level command","category":"TCL","categorySlug":"tcl","summary":"The esc-level BASIC program specifies that pressing ESC pushes a level. The esc-level command uses the set-esc command to enable the special escape key. Without any argument, the usual escape value (x&#39;1B&#39; or 27) is assigned to the level pushing function. The optional argument defines an alternate value.","url":"https://d3codex.com/tcl/esc-level-command/","api":"https://d3codex.com/api/topics/tcl/esc-level-command.json"},{"slug":"tcl/esc-toggle-command","title":"esc-toggle command","category":"TCL","categorySlug":"tcl","summary":"The esc-toggle BASIC program turns the function of the ESC key to either be treated as data (esc-data) or as a level-pushing mechanism (esc-level).","url":"https://d3codex.com/tcl/esc-toggle-command/","api":"https://d3codex.com/api/topics/tcl/esc-toggle-command.json"},{"slug":"tcl/estimate-count-command","title":"estimate-count command","category":"TCL","categorySlug":"tcl","summary":"The estimate-count BASIC program displays a fast estimate of the number of items in a file.","url":"https://d3codex.com/tcl/estimate-count-command/","api":"https://d3codex.com/api/topics/tcl/estimate-count-command.json"},{"slug":"tcl/exchange-command","title":"exchange command","category":"TCL","categorySlug":"tcl","summary":"The exchange BASIC program switches item-IDs of the two specified items following the file reference.","url":"https://d3codex.com/tcl/exchange-command/","api":"https://d3codex.com/api/topics/tcl/exchange-command.json"},{"slug":"tcl/exclamation-command","title":"! command","category":"TCL","categorySlug":"tcl","summary":"The ! command creates a UNIX shell and executes any UNIX command.","url":"https://d3codex.com/tcl/exclamation-command/","api":"https://d3codex.com/api/topics/tcl/exclamation-command.json"},{"slug":"tcl/exec-command","title":"exec command","category":"TCL","categorySlug":"tcl","summary":"The exec command runs the current process on the specified ABS area. This has the effect of changing the environment of the D3 Virtual operating system for this process, until log off time. At log off, the abs file is automatically reset to the dm,abs, file.","url":"https://d3codex.com/tcl/exec-command/","api":"https://d3codex.com/api/topics/tcl/exec-command.json"},{"slug":"tcl/exec-stacking-off-macro","title":"exec-stacking-off macro","category":"TCL","categorySlug":"tcl","summary":"The exec-stacking-off macro disables nested executes to be performed in an atomic manner.","url":"https://d3codex.com/tcl/exec-stacking-off-macro/","api":"https://d3codex.com/api/topics/tcl/exec-stacking-off-macro.json"},{"slug":"tcl/exec-stacking-on-macro","title":"exec-stacking-on macro","category":"TCL","categorySlug":"tcl","summary":"The exec-stacking-on macro enables nested executes to be performed in an atomic manner.","url":"https://d3codex.com/tcl/exec-stacking-on-macro/","api":"https://d3codex.com/api/topics/tcl/exec-stacking-on-macro.json"},{"slug":"tcl/exit-command","title":"exit command","category":"TCL","categorySlug":"tcl","summary":"The exit command logs the D3 process off and disconnects it from the D3 virtual machine. Even if the command exit does not exist, the system still exits with the proper privileges.","url":"https://d3codex.com/tcl/exit-command/","api":"https://d3codex.com/api/topics/tcl/exit-command.json"},{"slug":"tcl/export-command","title":"export command","category":"TCL","categorySlug":"tcl","summary":"The export command exports D3 items to UNIX files.","url":"https://d3codex.com/tcl/export-command/","api":"https://d3codex.com/api/topics/tcl/export-command.json"},{"slug":"tcl/f-modulo-command","title":"f.modulo command","category":"TCL","categorySlug":"tcl","summary":"The f.modulo command in the DM account calculates a file modulo, based on estimated file characteristics. The f.modulo command prompts for the number of items, item-ID size, and item size.","url":"https://d3codex.com/tcl/f-modulo-command/","api":"https://d3codex.com/api/topics/tcl/f-modulo-command.json"},{"slug":"tcl/f-resize-command","title":"f-resize command","category":"TCL","categorySlug":"tcl","summary":"The f-resize command in the DM account examines existing file modulos (VME only) for every file found in the file-of-files file, and recalculates a new recommended modulo for each file.","url":"https://d3codex.com/tcl/f-resize-command/","api":"https://d3codex.com/api/topics/tcl/f-resize-command.json"},{"slug":"tcl/fid-command","title":"fid command","category":"TCL","categorySlug":"tcl","summary":"The fid BASIC program displays information about a memory-resident frame.","url":"https://d3codex.com/tcl/fid-command/","api":"https://d3codex.com/api/topics/tcl/fid-command.json"},{"slug":"tcl/field-command","title":"field command","category":"TCL","categorySlug":"tcl","summary":"The field BASIC program prints out the nth word in a list of words. This is useful when combined with the TCL shell variables.","url":"https://d3codex.com/tcl/field-command/","api":"https://d3codex.com/api/topics/tcl/field-command.json"},{"slug":"tcl/file-access-setup-command","title":"file-access-setup command","category":"TCL","categorySlug":"tcl","summary":"The file-access-setup command in the dm account provides utilities for managing file update and retrieval locks on groups of files and users.","url":"https://d3codex.com/tcl/file-access-setup-command/","api":"https://d3codex.com/api/topics/tcl/file-access-setup-command.json"},{"slug":"tcl/file-save-command","title":"file-save command","category":"TCL","categorySlug":"tcl","summary":"The file-save command in the DM account invokes the procedure to perform a full backup of each file in the D3 file system.","url":"https://d3codex.com/tcl/file-save-command/","api":"https://d3codex.com/api/topics/tcl/file-save-command.json"},{"slug":"tcl/file-sizer-command","title":"file-sizer command","category":"TCL","categorySlug":"tcl","summary":"The file-sizer command displays the D3 File Sizer utility which allows automatic or manual resizing of D3 Windows or D3 UNIX files. For more information on the use of the D3 File Sizer utility, see the D3 File Sizer utility topic in the D3 System Administration Guide appropriate to your platform (either Windows, AIX or Linux).","url":"https://d3codex.com/tcl/file-sizer-command/","api":"https://d3codex.com/api/topics/tcl/file-sizer-command.json"},{"slug":"tcl/find-command","title":"find command","category":"TCL","categorySlug":"tcl","summary":"The find BASIC program searches a file for the existence of one or more strings of characters in any attribute, and optionally creates and saves a list.","url":"https://d3codex.com/tcl/find-command/","api":"https://d3codex.com/api/topics/tcl/find-command.json"},{"slug":"tcl/find2-command","title":"find2 command","category":"TCL","categorySlug":"tcl","summary":"The find2 BASIC program invokes the search-system command.","url":"https://d3codex.com/tcl/find2-command/","api":"https://d3codex.com/api/topics/tcl/find2-command.json"},{"slug":"tcl/fl-command","title":"fl command","category":"TCL","categorySlug":"tcl","summary":"The fl BASIC program forms a single list from two lists using intersection, union, or exclusion operators.","url":"https://d3codex.com/tcl/fl-command/","api":"https://d3codex.com/api/topics/tcl/fl-command.json"},{"slug":"tcl/flashbasic-command","title":"flashbasic command","category":"TCL","categorySlug":"tcl","summary":"The flashbasic command toggles FlashBASIC on and off.","url":"https://d3codex.com/tcl/flashbasic-command/","api":"https://d3codex.com/api/topics/tcl/flashbasic-command.json"},{"slug":"tcl/flip-list-command","title":"flip-list command","category":"TCL","categorySlug":"tcl","summary":"The flip-list command inverts the order of the specified select list.","url":"https://d3codex.com/tcl/flip-list-command/","api":"https://d3codex.com/api/topics/tcl/flip-list-command.json"},{"slug":"tcl/flush-command","title":"flush command","category":"TCL","categorySlug":"tcl","summary":"The flush command in the DM account flushes to disk all memory-resident buffers that are tagged as write-required.","url":"https://d3codex.com/tcl/flush-command/","api":"https://d3codex.com/api/topics/tcl/flush-command.json"},{"slug":"tcl/flushd-command","title":"flushd command","category":"TCL","categorySlug":"tcl","summary":"The flushd BASIC program creates a new flush process when available buffers go below the percentage specified in criteria for the amount of time specified in interval.","url":"https://d3codex.com/tcl/flushd-command/","api":"https://d3codex.com/api/topics/tcl/flushd-command.json"},{"slug":"tcl/font-parms-command","title":"font-parms command","category":"TCL","categorySlug":"tcl","summary":"The font-parms BASIC program is used to upgrade fonts and is provided for conversion of fonts created before May 25, 1990. Before this date, arguments were ordered differently.","url":"https://d3codex.com/tcl/font-parms-command/","api":"https://d3codex.com/api/topics/tcl/font-parms-command.json"},{"slug":"tcl/format-command","title":"format command","category":"TCL","categorySlug":"tcl","summary":"The format BASIC program formats a floppy disk for use only with the D3 system. The density and drive specified by the last set-floppy or set-device command are used.","url":"https://d3codex.com/tcl/format-command/","api":"https://d3codex.com/api/topics/tcl/format-command.json"},{"slug":"tcl/free-command","title":"free command","category":"TCL","categorySlug":"tcl","summary":"The free BASIC program displays information on the used and unused frames on a D3 system. Reports VME free space (for FSI use host operating system utilities).","url":"https://d3codex.com/tcl/free-command/","api":"https://d3codex.com/api/topics/tcl/free-command.json"},{"slug":"tcl/fsck-command","title":"fsck command","category":"TCL","categorySlug":"tcl","summary":"The fsck command completes a more thorough check of the integrity and structure of your data than the save command. It also allows for fixing backward link errors automatically. This TCL command was implemented to allow its use without first entering the D3 Windows Monitor Debugger.","url":"https://d3codex.com/tcl/fsck-command/","api":"https://d3codex.com/api/topics/tcl/fsck-command.json"},{"slug":"tcl/fuser-command","title":"fuser command","category":"TCL","categorySlug":"tcl","summary":"The fuser BASIC program displays ownership information about a device.","url":"https://d3codex.com/tcl/fuser-command/","api":"https://d3codex.com/api/topics/tcl/fuser-command.json"},{"slug":"tcl/generic-restore-command","title":"generic-restore command","category":"TCL","categorySlug":"tcl","summary":"The generic-restore command restores a specially formatted account-save created by certain utility programs.","url":"https://d3codex.com/tcl/generic-restore-command/","api":"https://d3codex.com/api/topics/tcl/generic-restore-command.json"},{"slug":"tcl/get-fof-command","title":"get-fof command","category":"TCL","categorySlug":"tcl","summary":"The get-fof BASIC program returns the item-ID in the file-of-files file associated with the specified VME file.","url":"https://d3codex.com/tcl/get-fof-command/","api":"https://d3codex.com/api/topics/tcl/get-fof-command.json"},{"slug":"tcl/get-list-command","title":"get-list command","category":"TCL","categorySlug":"tcl","summary":"The get-list command activates an item-list from the pointer-file file. The default file is the pointer-file file.","url":"https://d3codex.com/tcl/get-list-command/","api":"https://d3codex.com/api/topics/tcl/get-list-command.json"},{"slug":"tcl/getfsiroot-command","title":"GetFsiRoot command","category":"TCL","categorySlug":"tcl","summary":"The GetFsiRoot BASIC program (Windows Only) returns a string representing the root location of the FSI data files on D3 Windows.","url":"https://d3codex.com/tcl/getfsiroot-command/","api":"https://d3codex.com/api/topics/tcl/getfsiroot-command.json"},{"slug":"tcl/getlogonmode-command","title":"GetLogonMode command","category":"TCL","categorySlug":"tcl","summary":"The GetLogonMode BASIC program (Windows Only) returns a string representing whether or not the Windows Authentication logon mode is enabled.","url":"https://d3codex.com/tcl/getlogonmode-command/","api":"https://d3codex.com/api/topics/tcl/getlogonmode-command.json"},{"slug":"tcl/group-command","title":"group command","category":"TCL","categorySlug":"tcl","summary":"The group command displays a summary of information about each group in a file.","url":"https://d3codex.com/tcl/group-command/","api":"https://d3codex.com/api/topics/tcl/group-command.json"},{"slug":"tcl/hot-backup-command-unix","title":"hot-backup command (UNIX)","category":"TCL","categorySlug":"tcl","summary":"The hot-backup command allows the set up and control of a hot backup configuration. A menu displays without any arguments. This is the normal form of operation.","url":"https://d3codex.com/tcl/hot-backup-command-unix/","api":"https://d3codex.com/api/topics/tcl/hot-backup-command-unix.json"},{"slug":"tcl/idate-command","title":"idate command","category":"TCL","categorySlug":"tcl","summary":"The idate command sets the system date format to the international standard.","url":"https://d3codex.com/tcl/idate-command/","api":"https://d3codex.com/api/topics/tcl/idate-command.json"},{"slug":"tcl/ignore-signals-command","title":"ignore-signals command","category":"TCL","categorySlug":"tcl","summary":"The ignore-signals BASIC program will not attempt to push a level or go into the debugger when any character is input.","url":"https://d3codex.com/tcl/ignore-signals-command/","api":"https://d3codex.com/api/topics/tcl/ignore-signals-command.json"},{"slug":"tcl/import-command","title":"import command","category":"TCL","categorySlug":"tcl","summary":"The import BASIC program imports UNIX files to D3 items.","url":"https://d3codex.com/tcl/import-command/","api":"https://d3codex.com/api/topics/tcl/import-command.json"},{"slug":"tcl/index-select-command","title":"index-select command","category":"TCL","categorySlug":"tcl","summary":"Use the index-select BASIC program to create an active list based on a single key or a range of keys.","url":"https://d3codex.com/tcl/index-select-command/","api":"https://d3codex.com/api/topics/tcl/index-select-command.json"},{"slug":"tcl/indexer-command","title":"indexer command","category":"TCL","categorySlug":"tcl","summary":"The indexer BASIC program rebuilds indexes on part or all of the files of the system.","url":"https://d3codex.com/tcl/indexer-command/","api":"https://d3codex.com/api/topics/tcl/indexer-command.json"},{"slug":"tcl/init-ovf-command","title":"init-ovf command","category":"TCL","categorySlug":"tcl","summary":"The init-ovf command in the DM account initiates the D3 overflow initialization, and is invoked as a phantom by the initovf command.","url":"https://d3codex.com/tcl/init-ovf-command/","api":"https://d3codex.com/api/topics/tcl/init-ovf-command.json"},{"slug":"tcl/init-pibs-command","title":"init-pibs command","category":"TCL","categorySlug":"tcl","summary":"The init-pibs command assigns all ports a terminal type by updating attribute 2 in the pibs file.","url":"https://d3codex.com/tcl/init-pibs-command/","api":"https://d3codex.com/api/topics/tcl/init-pibs-command.json"},{"slug":"tcl/initovf-command","title":"initovf command","category":"TCL","categorySlug":"tcl","summary":"The initovf command checks the overflow table to determine if it has previously been scrubbed and invokes the init-ovf command, if necessary.","url":"https://d3codex.com/tcl/initovf-command/","api":"https://d3codex.com/api/topics/tcl/initovf-command.json"},{"slug":"tcl/inputwait-command","title":"inputwait command","category":"TCL","categorySlug":"tcl","summary":"The inputwait command displays a message, and waits for given time to execute commands.","url":"https://d3codex.com/tcl/inputwait-command/","api":"https://d3codex.com/api/topics/tcl/inputwait-command.json"},{"slug":"tcl/iselect-command","title":"iselect command","category":"TCL","categorySlug":"tcl","summary":"The iselect BASIC program selects all of the item-IDs in the group that the specified item-ID hashes to, using the item command.","url":"https://d3codex.com/tcl/iselect-command/","api":"https://d3codex.com/api/topics/tcl/iselect-command.json"},{"slug":"tcl/isselect-command","title":"isselect command","category":"TCL","categorySlug":"tcl","summary":"The isselect BASIC program selects and sorts all of the item-IDs in the group that the specified item-ID hashes to, using the item command.","url":"https://d3codex.com/tcl/isselect-command/","api":"https://d3codex.com/api/topics/tcl/isselect-command.json"},{"slug":"tcl/item-command","title":"item command","category":"TCL","categorySlug":"tcl","summary":"The item command outputs the base FID of the group to which the specified item-ID hashes, and a list of all item-IDs that are currently hashed to the same group.","url":"https://d3codex.com/tcl/item-command/","api":"https://d3codex.com/api/topics/tcl/item-command.json"},{"slug":"tcl/job-status-command","title":"job-status command","category":"TCL","categorySlug":"tcl","summary":"The job-status BASIC program returns status information of a job.","url":"https://d3codex.com/tcl/job-status-command/","api":"https://d3codex.com/api/topics/tcl/job-status-command.json"},{"slug":"tcl/kill-command","title":"kill command","category":"TCL","categorySlug":"tcl","summary":"The kill UNIX BASIC program sends a UNIX signal to a D3 or UNIX process. Signals can be specified by their names, rather than by their number, and D3 processes by their port numbers instead of the UNIX PIDs.","url":"https://d3codex.com/tcl/kill-command/","api":"https://d3codex.com/api/topics/tcl/kill-command.json"},{"slug":"tcl/kill-resizing-command","title":"kill-resizing command","category":"TCL","categorySlug":"tcl","summary":"The kill-resizing BASIC program stops all currently active resizing processes.","url":"https://d3codex.com/tcl/kill-resizing-command/","api":"https://d3codex.com/api/topics/tcl/kill-resizing-command.json"},{"slug":"tcl/ld-command","title":"ld command","category":"TCL","categorySlug":"tcl","summary":"The ld command presents the best guess of what one wants to see in a columnar listing of any dictionary.","url":"https://d3codex.com/tcl/ld-command/","api":"https://d3codex.com/api/topics/tcl/ld-command.json"},{"slug":"tcl/ldf-macro","title":"ldf macro","category":"TCL","categorySlug":"tcl","summary":"The ldf macro lists the summary description (attribute 17) of each attribute-defining item in the specified file.","url":"https://d3codex.com/tcl/ldf-macro/","api":"https://d3codex.com/api/topics/tcl/ldf-macro.json"},{"slug":"tcl/legend-command","title":"legend command","category":"TCL","categorySlug":"tcl","summary":"The legend is a static statement stored as an item in dm,messages, file. This is in contrast to headings and footings, which are dynamic, changing with each page output.","url":"https://d3codex.com/tcl/legend-command/","api":"https://d3codex.com/api/topics/tcl/legend-command.json"},{"slug":"tcl/lerrs-macro","title":"lerrs macro","category":"TCL","categorySlug":"tcl","summary":"The lerrs macro performs a series of reports from the dm,errors, file.","url":"https://d3codex.com/tcl/lerrs-macro/","api":"https://d3codex.com/api/topics/tcl/lerrs-macro.json"},{"slug":"tcl/level-pushing","title":"Level pushing","category":"TCL","categorySlug":"tcl","summary":"Level pushing is a term used to describe the ability to interrupt a process, invoke a new TCL prompt, and execute any valid TCL command.","url":"https://d3codex.com/tcl/level-pushing/","api":"https://d3codex.com/api/topics/tcl/level-pushing.json"},{"slug":"tcl/lfd-macro","title":"lfd macro","category":"TCL","categorySlug":"tcl","summary":"The lfd macro produces a sorted listing of all file-defining items in the specified file, along with the description attribute from each file pointer.","url":"https://d3codex.com/tcl/lfd-macro/","api":"https://d3codex.com/api/topics/tcl/lfd-macro.json"},{"slug":"tcl/lfs-macro","title":"lfs macro","category":"TCL","categorySlug":"tcl","summary":"The lfs macro contains the AQL sentence which uses the dm,file-of-files file. Any options from list-file-stats are appended to the macro and included in the sentence. This macro is invoked by the list-file-stats and file-save commands.","url":"https://d3codex.com/tcl/lfs-macro/","api":"https://d3codex.com/api/topics/tcl/lfs-macro.json"},{"slug":"tcl/lfsb-macro","title":"lfsb macro","category":"TCL","categorySlug":"tcl","summary":"This macro is the same as the lfsi macro except that the i-fms column becomes index-fms. index-fms is the number of frames in the index only. That is, the number excludes the number of frames used in the file.","url":"https://d3codex.com/tcl/lfsb-macro/","api":"https://d3codex.com/api/topics/tcl/lfsb-macro.json"},{"slug":"tcl/lfsi-macro","title":"lfsi macro","category":"TCL","categorySlug":"tcl","summary":"This macro is the same as the lfs macro except that the bytes column becomes i-bytes and the frames column becomes i-fms. i-bytes is the sum of the number of index frames times the frame size plus the number of bytes in the file (that is, indexes + data). i-fms is the sum of the number of frames in the index plus the number of frames in the file.","url":"https://d3codex.com/tcl/lfsi-macro/","api":"https://d3codex.com/api/topics/tcl/lfsi-macro.json"},{"slug":"tcl/line-continuation","title":"Line continuation","category":"TCL","categorySlug":"tcl","summary":"Any line ending with an underscore is merged with the succeeding line when processed by the paragraph processor.","url":"https://d3codex.com/tcl/line-continuation/","api":"https://d3codex.com/api/topics/tcl/line-continuation.json"},{"slug":"tcl/link-pibdev-command","title":"link-pibdev command","category":"TCL","categorySlug":"tcl","summary":"The link-pibdev BASIC program creates a logical link between the given (or current) process and the specified port number.","url":"https://d3codex.com/tcl/link-pibdev-command/","api":"https://d3codex.com/api/topics/tcl/link-pibdev-command.json"},{"slug":"tcl/list-aborts-command","title":"list-aborts command","category":"TCL","categorySlug":"tcl","summary":"The list-aborts command produces a sorted report of the aborts logged into the dm,errors, file, beginning with the most recently logged message. It is different from the list-errors macro in that it only displays aborts not informational messages (such as logoffs or system boots).","url":"https://d3codex.com/tcl/list-aborts-command/","api":"https://d3codex.com/api/topics/tcl/list-aborts-command.json"},{"slug":"tcl/list-abs-macro","title":"list-abs macro","category":"TCL","categorySlug":"tcl","summary":"The list-abs macro produces a report of each D3 mode in the dm,abs, file, showing any modes it calls and those modes which are called.","url":"https://d3codex.com/tcl/list-abs-macro/","api":"https://d3codex.com/api/topics/tcl/list-abs-macro.json"},{"slug":"tcl/list-commands-macro","title":"list-commands macro","category":"TCL","categorySlug":"tcl","summary":"The list-commands macro produces a report showing every executable command in the specified master dictionary (md); this includes: Procs, macros, menus, cataloged FlashBASIC programs (BASIC commands) and D3 commands.","url":"https://d3codex.com/tcl/list-commands-macro/","api":"https://d3codex.com/api/topics/tcl/list-commands-macro.json"},{"slug":"tcl/list-device-command","title":"list-device command","category":"TCL","categorySlug":"tcl","summary":"The list-device command shows the currently defined devices.","url":"https://d3codex.com/tcl/list-device-command/","api":"https://d3codex.com/api/topics/tcl/list-device-command.json"},{"slug":"tcl/list-errors-macro","title":"list-errors macro","category":"TCL","categorySlug":"tcl","summary":"The list-errors macro produces a sorted report of the error messages logged into the dm,errors, file, beginning with the most recently logged message.","url":"https://d3codex.com/tcl/list-errors-macro/","api":"https://d3codex.com/api/topics/tcl/list-errors-macro.json"},{"slug":"tcl/list-file-access-command","title":"list-file-access command","category":"TCL","categorySlug":"tcl","summary":"The list-file-access BASIC program displays file access statistics for the desired files.","url":"https://d3codex.com/tcl/list-file-access-command/","api":"https://d3codex.com/api/topics/tcl/list-file-access-command.json"},{"slug":"tcl/list-file-stats-command","title":"list-file-stats command","category":"TCL","categorySlug":"tcl","summary":"The list-file-stats BASIC program produces the file statistics report generated from the most recently executed file-save command or account-save command.","url":"https://d3codex.com/tcl/list-file-stats-command/","api":"https://d3codex.com/api/topics/tcl/list-file-stats-command.json"},{"slug":"tcl/list-files-command","title":"list-files command","category":"TCL","categorySlug":"tcl","summary":"The list-files BASIC program produces a report of all file-defining items(D-pointers) and synonym-defining items (Q-pointers).","url":"https://d3codex.com/tcl/list-files-command/","api":"https://d3codex.com/api/topics/tcl/list-files-command.json"},{"slug":"tcl/list-index-command","title":"list-index command","category":"TCL","categorySlug":"tcl","summary":"The list-index BASIC program lists all indexes for a given file name, account name, or for the system.","url":"https://d3codex.com/tcl/list-index-command/","api":"https://d3codex.com/api/topics/tcl/list-index-command.json"},{"slug":"tcl/list-item-locks-macro","title":"list-item-locks macro","category":"TCL","categorySlug":"tcl","summary":"The list-item-locks macro displays a list of item-locks only.","url":"https://d3codex.com/tcl/list-item-locks-macro/","api":"https://d3codex.com/api/topics/tcl/list-item-locks-macro.json"},{"slug":"tcl/list-jobs-macro","title":"list-jobs macro","category":"TCL","categorySlug":"tcl","summary":"The list-jobs macro produces a report indicating the status of all phantom controlled processes currently in the dm,jobs, file.","url":"https://d3codex.com/tcl/list-jobs-macro/","api":"https://d3codex.com/api/topics/tcl/list-jobs-macro.json"},{"slug":"tcl/list-lines-command","title":"list-lines command","category":"TCL","categorySlug":"tcl","summary":"The list-lines BASIC program displays communications protocol information for every port attached to the virtual machine.","url":"https://d3codex.com/tcl/list-lines-command/","api":"https://d3codex.com/api/topics/tcl/list-lines-command.json"},{"slug":"tcl/list-lists-macro","title":"list-lists macro","category":"TCL","categorySlug":"tcl","summary":"The list-lists macro produces a sorted report of all previously saved lists in the pointer-file file.","url":"https://d3codex.com/tcl/list-lists-macro/","api":"https://d3codex.com/api/topics/tcl/list-lists-macro.json"},{"slug":"tcl/list-lockq-command","title":"list-lockq command","category":"TCL","categorySlug":"tcl","summary":"The list-lockq command lists the VME processes that are enqueue (waiting) to lock a frame, that is currently locked by some other process.","url":"https://d3codex.com/tcl/list-lockq-command/","api":"https://d3codex.com/api/topics/tcl/list-lockq-command.json"},{"slug":"tcl/list-locks-command","title":"list-locks command","category":"TCL","categorySlug":"tcl","summary":"The list-locks BASIC program displays the current status of all system, FlashBASIC, spooler, group, and item locks.","url":"https://d3codex.com/tcl/list-locks-command/","api":"https://d3codex.com/api/topics/tcl/list-locks-command.json"},{"slug":"tcl/list-logoffs-command","title":"list-logoffs command","category":"TCL","categorySlug":"tcl","summary":"The list-logoffs BASIC program produces a report showing the history of logoffs recorded in the dm,errors, file, along with who logged off and the status of the logged off port.","url":"https://d3codex.com/tcl/list-logoffs-command/","api":"https://d3codex.com/api/topics/tcl/list-logoffs-command.json"},{"slug":"tcl/list-macros-macro","title":"list-macros macro","category":"TCL","categorySlug":"tcl","summary":"The list-macros macro produces a sorted report of all items defined as macros in the specified account name or your local MD (if md is specified).","url":"https://d3codex.com/tcl/list-macros-macro/","api":"https://d3codex.com/api/topics/tcl/list-macros-macro.json"},{"slug":"tcl/list-menu-command","title":"list-menu command","category":"TCL","categorySlug":"tcl","summary":"The list-menu command produces a documentation quality presentation format of menu(s).","url":"https://d3codex.com/tcl/list-menu-command/","api":"https://d3codex.com/api/topics/tcl/list-menu-command.json"},{"slug":"tcl/list-menus-macro","title":"list-menus macro","category":"TCL","categorySlug":"tcl","summary":"The list-menus macros produces a sorted listing of all items defined as menus in the specified master dictionary.","url":"https://d3codex.com/tcl/list-menus-macro/","api":"https://d3codex.com/api/topics/tcl/list-menus-macro.json"},{"slug":"tcl/list-obj-command","title":"list-obj command","category":"TCL","categorySlug":"tcl","summary":"The list-obj BASIC program outputs descriptive internal information about programs compiled for BASIC and FlashBASIC.","url":"https://d3codex.com/tcl/list-obj-command/","api":"https://d3codex.com/api/topics/tcl/list-obj-command.json"},{"slug":"tcl/list-pibs-macro","title":"list-pibs macro","category":"TCL","categorySlug":"tcl","summary":"The list-pibs macro produces a report of each active port in the dm,pibs, file, showing the port number, the current user of that port and the current terminal/printer characteristics as defined by the term-type command.","url":"https://d3codex.com/tcl/list-pibs-macro/","api":"https://d3codex.com/api/topics/tcl/list-pibs-macro.json"},{"slug":"tcl/list-resizing-macro","title":"list-resizing macro","category":"TCL","categorySlug":"tcl","summary":"The list-resizing command lists the status of files currently being resized from the dm,resizing file.","url":"https://d3codex.com/tcl/list-resizing-macro/","api":"https://d3codex.com/api/topics/tcl/list-resizing-macro.json"},{"slug":"tcl/list-restore-errors-command","title":"list-restore-errors command","category":"TCL","categorySlug":"tcl","summary":"The list-restore-errors BASIC program displays errors recorded during restore.","url":"https://d3codex.com/tcl/list-restore-errors-command/","api":"https://d3codex.com/api/topics/tcl/list-restore-errors-command.json"},{"slug":"tcl/list-runaway-limit-command","title":"list-runaway-limit command","category":"TCL","categorySlug":"tcl","summary":"The list-runaway-limit command lists the overflow runaway settings for all pibs. This includes the current runaway limit and whether the set-runaway-autoquit feature is set to on or off.","url":"https://d3codex.com/tcl/list-runaway-limit-command/","api":"https://d3codex.com/api/topics/tcl/list-runaway-limit-command.json"},{"slug":"tcl/list-runtime-errors-macro","title":"list-runtime-errors macro","category":"TCL","categorySlug":"tcl","summary":"The list-runtime-errors macro produces a sorted report of error conditions logged into the dm,runtime-errors, file.","url":"https://d3codex.com/tcl/list-runtime-errors-macro/","api":"https://d3codex.com/api/topics/tcl/list-runtime-errors-macro.json"},{"slug":"tcl/list-system-errors-macro","title":"list-system-errors macro","category":"TCL","categorySlug":"tcl","summary":"The list-system-errors macro produces a sorted report of error conditions logged into the dm,errors, file.","url":"https://d3codex.com/tcl/list-system-errors-macro/","api":"https://d3codex.com/api/topics/tcl/list-system-errors-macro.json"},{"slug":"tcl/list-tandems-command","title":"list-tandems command","category":"TCL","categorySlug":"tcl","summary":"The list-tandems BASIC program lists the devices currently involved in a tandem association.","url":"https://d3codex.com/tcl/list-tandems-command/","api":"https://d3codex.com/api/topics/tcl/list-tandems-command.json"},{"slug":"tcl/list-users-command","title":"list-users command","category":"TCL","categorySlug":"tcl","summary":"The list-users BASIC program produces a report of users currently logged on to the system.","url":"https://d3codex.com/tcl/list-users-command/","api":"https://d3codex.com/api/topics/tcl/list-users-command.json"},{"slug":"tcl/listabs-command","title":"listabs command","category":"TCL","categorySlug":"tcl","summary":"The listabs command displays the current spooler assignment parameters for each process on the system.","url":"https://d3codex.com/tcl/listabs-command/","api":"https://d3codex.com/api/topics/tcl/listabs-command.json"},{"slug":"tcl/listacc-command","title":"listacc command","category":"TCL","categorySlug":"tcl","summary":"The listacc BASIC program produces a report of system usage statistics from the dm,acc, file for all accounts, or for a specified account, or for a specific user-ID.","url":"https://d3codex.com/tcl/listacc-command/","api":"https://d3codex.com/api/topics/tcl/listacc-command.json"},{"slug":"tcl/listbi-command","title":"listbi command","category":"TCL","categorySlug":"tcl","summary":"The listbi command lists the built-in c functions in the item UNIX.builtin, c.builtin (MS-DOS) and user.builtin located in the dm,messages, file. These include any built-in c functions that have been added using the addbi command.","url":"https://d3codex.com/tcl/listbi-command/","api":"https://d3codex.com/api/topics/tcl/listbi-command.json"},{"slug":"tcl/listc-command","title":"listc command","category":"TCL","categorySlug":"tcl","summary":"The listc BASIC program invokes the list-label BASIC program to produce a columnar display of the item-IDs in the specified file, in the order of appearance in the file.","url":"https://d3codex.com/tcl/listc-command/","api":"https://d3codex.com/api/topics/tcl/listc-command.json"},{"slug":"tcl/listconn-command","title":"listconn command","category":"TCL","categorySlug":"tcl","summary":"The listconn BASIC program produces a report of all items defined as connectives (also called modifiers) in the specified file reference.","url":"https://d3codex.com/tcl/listconn-command/","api":"https://d3codex.com/api/topics/tcl/listconn-command.json"},{"slug":"tcl/listdict-command","title":"listdict command","category":"TCL","categorySlug":"tcl","summary":"The listdict BASIC program sorts the given file’s dictionary items by attribute count and by item-id then produces a report showing the contents of the various ADIs.","url":"https://d3codex.com/tcl/listdict-command/","api":"https://d3codex.com/api/topics/tcl/listdict-command.json"},{"slug":"tcl/listfiles-command","title":"listfiles command","category":"TCL","categorySlug":"tcl","summary":"The listfiles BASIC program produces a report showing all file-defining items and synonym-defining items in an optionally specified file name or account name. The default file name is md.","url":"https://d3codex.com/tcl/listfiles-command/","api":"https://d3codex.com/api/topics/tcl/listfiles-command.json"},{"slug":"tcl/listpeqs-command","title":"listpeqs command","category":"TCL","categorySlug":"tcl","summary":"The listpeqs command displays the status of all spooler controlled print job elements. The spooler account holds a file called peqs that is used to reference spooler jobs as normal D3 items and can be listed, sorted, and selected in any sequence.","url":"https://d3codex.com/tcl/listpeqs-command/","api":"https://d3codex.com/api/topics/tcl/listpeqs-command.json"},{"slug":"tcl/listprocs-command","title":"listprocs command","category":"TCL","categorySlug":"tcl","summary":"The listprocs BASIC program produces a sorted report of all items defined as Procs in the specified file name. The default file name is md when none is specified.","url":"https://d3codex.com/tcl/listprocs-command/","api":"https://d3codex.com/api/topics/tcl/listprocs-command.json"},{"slug":"tcl/listptr-command","title":"listptr command","category":"TCL","categorySlug":"tcl","summary":"The listptr command displays the printer control block status for all printers.","url":"https://d3codex.com/tcl/listptr-command/","api":"https://d3codex.com/api/topics/tcl/listptr-command.json"},{"slug":"tcl/listverbs-command","title":"listverbs command","category":"TCL","categorySlug":"tcl","summary":"The listverbs BASIC program produces a sorted listing of all items defined as command in the specified account name.","url":"https://d3codex.com/tcl/listverbs-command/","api":"https://d3codex.com/api/topics/tcl/listverbs-command.json"},{"slug":"tcl/load-mon2-command","title":"load.mon2 command","category":"TCL","categorySlug":"tcl","summary":"The load.mon2 BASIC program displays a graphical map of the duty load of the D3 system, taking a snapshot of the system at a given time interval.","url":"https://d3codex.com/tcl/load-mon2-command/","api":"https://d3codex.com/api/topics/tcl/load-mon2-command.json"},{"slug":"tcl/lock-beep-command","title":"lock-beep command","category":"TCL","categorySlug":"tcl","summary":"The lock-beep command enables/disables beeping on lock failure.","url":"https://d3codex.com/tcl/lock-beep-command/","api":"https://d3codex.com/api/topics/tcl/lock-beep-command.json"},{"slug":"tcl/lock-break-command","title":"lock-break command","category":"TCL","categorySlug":"tcl","summary":"The lock-break command enables or disables the ability to unconditionally break during a lock failure.","url":"https://d3codex.com/tcl/lock-break-command/","api":"https://d3codex.com/api/topics/tcl/lock-break-command.json"},{"slug":"tcl/lock-frame-command","title":"lock-frame command","category":"TCL","categorySlug":"tcl","summary":"The lock-frame command core locks a frame into real memory. This prevents the frame from being flushed to disk for any reason.","url":"https://d3codex.com/tcl/lock-frame-command/","api":"https://d3codex.com/api/topics/tcl/lock-frame-command.json"},{"slug":"tcl/locks-spooler","title":"Locks (Spooler)","category":"TCL","categorySlug":"tcl","summary":"A lock is a software security feature for the application to run correctly.","url":"https://d3codex.com/tcl/locks-spooler/","api":"https://d3codex.com/api/topics/tcl/locks-spooler.json"},{"slug":"tcl/log-clear-file-off-macro","title":"log-clear-file-off macro","category":"TCL","categorySlug":"tcl","summary":"The log-clear-file-off macro turns off the logging of the clear-file command.","url":"https://d3codex.com/tcl/log-clear-file-off-macro/","api":"https://d3codex.com/api/topics/tcl/log-clear-file-off-macro.json"},{"slug":"tcl/log-clear-file-on-macro","title":"log-clear-file-on macro","category":"TCL","categorySlug":"tcl","summary":"The log-clear-file-on macro turns on the logging of the clear-file command.","url":"https://d3codex.com/tcl/log-clear-file-on-macro/","api":"https://d3codex.com/api/topics/tcl/log-clear-file-on-macro.json"},{"slug":"tcl/log-msg-command","title":"log-msg command","category":"TCL","categorySlug":"tcl","summary":"The log-msg command records the time and date that a particular macro is executed.","url":"https://d3codex.com/tcl/log-msg-command/","api":"https://d3codex.com/api/topics/tcl/log-msg-command.json"},{"slug":"tcl/log-status-command","title":"log-status command","category":"TCL","categorySlug":"tcl","summary":"The log-status command displays the current status of the transaction logger.","url":"https://d3codex.com/tcl/log-status-command/","api":"https://d3codex.com/api/topics/tcl/log-status-command.json"},{"slug":"tcl/logoff-command","title":"logoff command","category":"TCL","categorySlug":"tcl","summary":"The logoff BASIC program terminates a process on a given port and sends the port to the logon prompt.","url":"https://d3codex.com/tcl/logoff-command/","api":"https://d3codex.com/api/topics/tcl/logoff-command.json"},{"slug":"tcl/logon-command","title":"logon command","category":"TCL","categorySlug":"tcl","summary":"The logon command logs on a port, other than the one currently being used, onto a specific account.","url":"https://d3codex.com/tcl/logon-command/","api":"https://d3codex.com/api/topics/tcl/logon-command.json"},{"slug":"tcl/logon-lock-command","title":"logon-lock command","category":"TCL","categorySlug":"tcl","summary":"The logon-lock command turns on or off the logon lockout feature.","url":"https://d3codex.com/tcl/logon-lock-command/","api":"https://d3codex.com/api/topics/tcl/logon-lock-command.json"},{"slug":"tcl/logon-reporting-command","title":"logon-reporting command","category":"TCL","categorySlug":"tcl","summary":"The logon-reporting command turns on or off the logon reporting feature which logs failed logon attempts to the errors file.","url":"https://d3codex.com/tcl/logon-reporting-command/","api":"https://d3codex.com/api/topics/tcl/logon-reporting-command.json"},{"slug":"tcl/logon-timeout-command","title":"logon-timeout command","category":"TCL","categorySlug":"tcl","summary":"The logon-timeout command updates and displays the global and local logon timeout values. The global timeout value is a default value for the D3 server and the local timeout value is used to override the global value on a specified process. By default, processes are initialized to use the global logon timeout value.","url":"https://d3codex.com/tcl/logon-timeout-command/","api":"https://d3codex.com/api/topics/tcl/logon-timeout-command.json"},{"slug":"tcl/logto-command","title":"logto command","category":"TCL","categorySlug":"tcl","summary":"The logto command terminates accounting on the current account, and then moves to another specified account. If a password is present, it must be provided. Passwords are case-sensitive.","url":"https://d3codex.com/tcl/logto-command/","api":"https://d3codex.com/api/topics/tcl/logto-command.json"},{"slug":"tcl/loop-command","title":"loop command","category":"TCL","categorySlug":"tcl","summary":"The loop BASIC program performs any TCL command a specific number of times, or continuously, until any key is pressed on the keyboard.","url":"https://d3codex.com/tcl/loop-command/","api":"https://d3codex.com/api/topics/tcl/loop-command.json"},{"slug":"tcl/looping","title":"Looping","category":"TCL","categorySlug":"tcl","summary":"Paragraphs allow simple loops by starting a block of commands with the loop command and ending that block with the repeat command. The loop command indicates the beginning of a loop in a paragraph.","url":"https://d3codex.com/tcl/looping/","api":"https://d3codex.com/api/topics/tcl/looping.json"},{"slug":"tcl/macro-statements","title":"Macro statements","category":"TCL","categorySlug":"tcl","summary":"The following macro statements are supported:","url":"https://d3codex.com/tcl/macro-statements/","api":"https://d3codex.com/api/topics/tcl/macro-statements.json"},{"slug":"tcl/macros-tcl","title":"Macros","category":"TCL","categorySlug":"tcl","summary":"A macro is a process that executes one or more TCL commands. Macros are stored in the master dictionary with the name of the macro as the item-ID. The macro processor is provided for simple TCL procedures. In general, complex procedures should be written as BASIC programs.","url":"https://d3codex.com/tcl/macros-tcl/","api":"https://d3codex.com/api/topics/tcl/macros-tcl.json"},{"slug":"tcl/maxusers-command","title":"maxusers command","category":"TCL","categorySlug":"tcl","summary":"The maxusers command displays the number of licensed D3 users on the system, and/or sets the system in single or multiuser mode.","url":"https://d3codex.com/tcl/maxusers-command/","api":"https://d3codex.com/api/topics/tcl/maxusers-command.json"},{"slug":"tcl/menus-tcl","title":"Menus","category":"TCL","categorySlug":"tcl","summary":"A menu provides a selection of processing choices. Menus are items in the master dictionary. The menu processor (me in attribute 1 of item) automatically formats the menu on the screen. You can then select one of the menu options for processing by entering the option number. The format of the menu item in the master dictionary is:","url":"https://d3codex.com/tcl/menus-tcl/","api":"https://d3codex.com/api/topics/tcl/menus-tcl.json"},{"slug":"tcl/mirror-command","title":"mirror command","category":"TCL","categorySlug":"tcl","summary":"The mirror BASIC program attaches the current process (the master) to one or more slave processes. All characters input or output to or from the master process display on each slave process.","url":"https://d3codex.com/tcl/mirror-command/","api":"https://d3codex.com/api/topics/tcl/mirror-command.json"},{"slug":"tcl/mlist-command","title":"mlist command","category":"TCL","categorySlug":"tcl","summary":"The mlist command produces formatted assembly source code listing of the specified item list.","url":"https://d3codex.com/tcl/mlist-command/","api":"https://d3codex.com/api/topics/tcl/mlist-command.json"},{"slug":"tcl/mload-command","title":"mload command","category":"TCL","categorySlug":"tcl","summary":"The mload command loads the assembled object code into the virtual memory address defined in the routine.","url":"https://d3codex.com/tcl/mload-command/","api":"https://d3codex.com/api/topics/tcl/mload-command.json"},{"slug":"tcl/modem-off-macro","title":"modem-off macro","category":"TCL","categorySlug":"tcl","summary":"The modem-off macro invokes the xonoff command and passes it an f option. This disables x-on/x-off on the current line or a specified line.","url":"https://d3codex.com/tcl/modem-off-macro/","api":"https://d3codex.com/api/topics/tcl/modem-off-macro.json"},{"slug":"tcl/modem-on-macro","title":"modem-on macro","category":"TCL","categorySlug":"tcl","summary":"The modem-on macro invokes the xonoff command and passes it an n option. This enables x-on/x-off on the current line or a given line.","url":"https://d3codex.com/tcl/modem-on-macro/","api":"https://d3codex.com/api/topics/tcl/modem-on-macro.json"},{"slug":"tcl/monitor-status-command","title":"monitor-status command","category":"TCL","categorySlug":"tcl","summary":"The monitor-status BASIC program produces a snapshot listing of information related to memory-resident frames.","url":"https://d3codex.com/tcl/monitor-status-command/","api":"https://d3codex.com/api/topics/tcl/monitor-status-command.json"},{"slug":"tcl/mono-command","title":"mono command","category":"TCL","categorySlug":"tcl","summary":"The mono BASIC program switches output to a monochrome display from a color display, or sets the visual attributes of the monitor.","url":"https://d3codex.com/tcl/mono-command/","api":"https://d3codex.com/api/topics/tcl/mono-command.json"},{"slug":"tcl/mount-cd-command","title":"mount-cd command","category":"TCL","categorySlug":"tcl","summary":"The mount-cd BASIC program creates a directory in Linux called /mnt/cdrom.","url":"https://d3codex.com/tcl/mount-cd-command/","api":"https://d3codex.com/api/topics/tcl/mount-cd-command.json"},{"slug":"tcl/move-file-command","title":"move-file command","category":"TCL","categorySlug":"tcl","summary":"The move-file BASIC program moves a file descriptor from one master dictionary to another. The dictionary may be file-level, account-level (master dictionary), or system-level (master dictionaries or system).","url":"https://d3codex.com/tcl/move-file-command/","api":"https://d3codex.com/api/topics/tcl/move-file-command.json"},{"slug":"tcl/mul-command","title":"mul command","category":"TCL","categorySlug":"tcl","summary":"The mul command multiplies the first integer number provided by the second integer number provided and displays the result as an integer number.","url":"https://d3codex.com/tcl/mul-command/","api":"https://d3codex.com/api/topics/tcl/mul-command.json"},{"slug":"tcl/mulx-command","title":"mulx command","category":"TCL","categorySlug":"tcl","summary":"The mulx command multiplies the first hexadecimal number provided by the second hexadecimal number provided and displays the result as a hexadecimal number.","url":"https://d3codex.com/tcl/mulx-command/","api":"https://d3codex.com/api/topics/tcl/mulx-command.json"},{"slug":"tcl/mverify-command","title":"mverify command","category":"TCL","categorySlug":"tcl","summary":"The mverify BASIC program compares the assembled object code in virtual memory against the corresponding itemlist in specified file name. Any frames with mismatches are reported.","url":"https://d3codex.com/tcl/mverify-command/","api":"https://d3codex.com/api/topics/tcl/mverify-command.json"},{"slug":"tcl/net-errors-command","title":"net-errors command","category":"TCL","categorySlug":"tcl","summary":"The net-errors BASIC program sets or displays error handling behavior when accessing remote files.","url":"https://d3codex.com/tcl/net-errors-command/","api":"https://d3codex.com/api/topics/tcl/net-errors-command.json"},{"slug":"tcl/net-status-macro","title":"net-status macro","category":"TCL","categorySlug":"tcl","summary":"The net-status macro displays statistics on local network usage.","url":"https://d3codex.com/tcl/net-status-macro/","api":"https://d3codex.com/api/topics/tcl/net-status-macro.json"},{"slug":"tcl/network-setup-utility","title":"network-setup utility","category":"TCL","categorySlug":"tcl","summary":"The network-setup utility allows the setup and control of a D3 network. If no arguments are supplied, a menu opens. This is the normal form of operation.","url":"https://d3codex.com/tcl/network-setup-utility/","api":"https://d3codex.com/api/topics/tcl/network-setup-utility.json"},{"slug":"tcl/network-status-command","title":"network-status command","category":"TCL","categorySlug":"tcl","summary":"The network-status BASIC program displays remote files opened by a line.","url":"https://d3codex.com/tcl/network-status-command/","api":"https://d3codex.com/api/topics/tcl/network-status-command.json"},{"slug":"tcl/nframe-index-command","title":"nframe-index command","category":"TCL","categorySlug":"tcl","summary":"The nframe-index command produces a total of the number of frames in use by a specific B-tree index, or all indexes if indicated by an asterisk.","url":"https://d3codex.com/tcl/nframe-index-command/","api":"https://d3codex.com/api/topics/tcl/nframe-index-command.json"},{"slug":"tcl/nt-cinfo-command","title":"nt_cinfo command","category":"TCL","categorySlug":"tcl","summary":"The nt_cinfo command obtains information about loaded C DLLs.","url":"https://d3codex.com/tcl/nt-cinfo-command/","api":"https://d3codex.com/api/topics/tcl/nt-cinfo-command.json"},{"slug":"tcl/nt-cload-command","title":"nt_cload command","category":"TCL","categorySlug":"tcl","summary":"The nt_cload command loads a C DLL.","url":"https://d3codex.com/tcl/nt-cload-command/","api":"https://d3codex.com/api/topics/tcl/nt-cload-command.json"},{"slug":"tcl/nt-cunload-command","title":"nt_cunload command","category":"TCL","categorySlug":"tcl","summary":"The nt_cunload command unloads a C DLL.","url":"https://d3codex.com/tcl/nt-cunload-command/","api":"https://d3codex.com/api/topics/tcl/nt-cunload-command.json"},{"slug":"tcl/nt-dllinfo-command","title":"nt_dllinfo command","category":"TCL","categorySlug":"tcl","summary":"The nt_dllinfo command obtains information about loaded DLLs.","url":"https://d3codex.com/tcl/nt-dllinfo-command/","api":"https://d3codex.com/api/topics/tcl/nt-dllinfo-command.json"},{"slug":"tcl/nt-dllload-command","title":"nt_dllload command","category":"TCL","categorySlug":"tcl","summary":"The nt_dllload command loads a DLL.","url":"https://d3codex.com/tcl/nt-dllload-command/","api":"https://d3codex.com/api/topics/tcl/nt-dllload-command.json"},{"slug":"tcl/nt-dllunload-command","title":"nt_dllunload command","category":"TCL","categorySlug":"tcl","summary":"The nt_dllunload command unloads a DLL.","url":"https://d3codex.com/tcl/nt-dllunload-command/","api":"https://d3codex.com/api/topics/tcl/nt-dllunload-command.json"},{"slug":"tcl/nt-eventlog-command","title":"nt_eventlog command","category":"TCL","categorySlug":"tcl","summary":"The nt_eventlog command displays or clears the Windows application or system event log.","url":"https://d3codex.com/tcl/nt-eventlog-command/","api":"https://d3codex.com/api/topics/tcl/nt-eventlog-command.json"},{"slug":"tcl/nt-file-info-command","title":"nt_file-info command","category":"TCL","categorySlug":"tcl","summary":"The nt_file-info command displays file information for a specified file.","url":"https://d3codex.com/tcl/nt-file-info-command/","api":"https://d3codex.com/api/topics/tcl/nt-file-info-command.json"},{"slug":"tcl/nt-getfsiaccount-command","title":"nt_getfsiaccount command","category":"TCL","categorySlug":"tcl","summary":"The nt_getfsiaccount command in the DM account, returns the current FSI account getting logged onto.","url":"https://d3codex.com/tcl/nt-getfsiaccount-command/","api":"https://d3codex.com/api/topics/tcl/nt-getfsiaccount-command.json"},{"slug":"tcl/nt-heapwalk-command","title":"nt_heapwalk command","category":"TCL","categorySlug":"tcl","summary":"The nt_heapwalk command in the DM account, will walk the ’heap’ of the given line and display the results in a human readable form. If the entire ’heap’ cannot fit into the buffer, then a message is displayed. This will indicate there is possibly memory fragmentation.","url":"https://d3codex.com/tcl/nt-heapwalk-command/","api":"https://d3codex.com/api/topics/tcl/nt-heapwalk-command.json"},{"slug":"tcl/nt-inv-flash-command","title":"nt_inv-flash command","category":"TCL","categorySlug":"tcl","summary":"The nt_inv-flash command tags the flashed program object in the cache as old. The next time the program is loaded, the latest version will be stored in the cache.","url":"https://d3codex.com/tcl/nt-inv-flash-command/","api":"https://d3codex.com/api/topics/tcl/nt-inv-flash-command.json"},{"slug":"tcl/nt-iotrace-command","title":"nt_iotrace command","category":"TCL","categorySlug":"tcl","summary":"The nt_iotrace command captures the i/o activity for a process id.","url":"https://d3codex.com/tcl/nt-iotrace-command/","api":"https://d3codex.com/api/topics/tcl/nt-iotrace-command.json"},{"slug":"tcl/nt-list-ilocks","title":"nt_list-ilocks command","category":"TCL","categorySlug":"tcl","summary":"The nt_list-ilocks command generates a report of the FSI item locks that are currently set.","url":"https://d3codex.com/tcl/nt-list-ilocks/","api":"https://d3codex.com/api/topics/tcl/nt-list-ilocks.json"},{"slug":"tcl/nt-list-jobs-command","title":"nt_list-jobs command","category":"TCL","categorySlug":"tcl","summary":"The nt_list-jobs command lists server jobs running on the server since rebooting.","url":"https://d3codex.com/tcl/nt-list-jobs-command/","api":"https://d3codex.com/api/topics/tcl/nt-list-jobs-command.json"},{"slug":"tcl/nt-list-resizing-command","title":"nt_list-resizing command","category":"TCL","categorySlug":"tcl","summary":"The nt_list-resizing command lists the files being resized and the files that have been resized.","url":"https://d3codex.com/tcl/nt-list-resizing-command/","api":"https://d3codex.com/api/topics/tcl/nt-list-resizing-command.json"},{"slug":"tcl/nt-listclients-command","title":"nt_listclients command","category":"TCL","categorySlug":"tcl","summary":"The nt_listclients command lists the active clients on the system.","url":"https://d3codex.com/tcl/nt-listclients-command/","api":"https://d3codex.com/api/topics/tcl/nt-listclients-command.json"},{"slug":"tcl/nt-makefof-command","title":"nt_makefof command","category":"TCL","categorySlug":"tcl","summary":"The nt_makefof command creates the entry in the FileOfFiles.","url":"https://d3codex.com/tcl/nt-makefof-command/","api":"https://d3codex.com/api/topics/tcl/nt-makefof-command.json"},{"slug":"tcl/nt-migrateacc-command","title":"nt_migrateacc command","category":"TCL","categorySlug":"tcl","summary":"The nt_migrateacc command migrates an account from the VME to the FSI.","url":"https://d3codex.com/tcl/nt-migrateacc-command/","api":"https://d3codex.com/api/topics/tcl/nt-migrateacc-command.json"},{"slug":"tcl/nt-name-command","title":"nt_name command","category":"TCL","categorySlug":"tcl","summary":"The nt_name command obtains network information.","url":"https://d3codex.com/tcl/nt-name-command/","api":"https://d3codex.com/api/topics/tcl/nt-name-command.json"},{"slug":"tcl/nt-osfi-start-command","title":"nt_osfi_start command","category":"TCL","categorySlug":"tcl","summary":"The nt_osfi_start command starts the OSFI server.","url":"https://d3codex.com/tcl/nt-osfi-start-command/","api":"https://d3codex.com/api/topics/tcl/nt-osfi-start-command.json"},{"slug":"tcl/nt-osfi-stop-command","title":"nt_osfi_stop command","category":"TCL","categorySlug":"tcl","summary":"The nt_osfi_stop command stops the OSFI server.","url":"https://d3codex.com/tcl/nt-osfi-stop-command/","api":"https://d3codex.com/api/topics/tcl/nt-osfi-stop-command.json"},{"slug":"tcl/nt-pinfo-command","title":"nt_pinfo command","category":"TCL","categorySlug":"tcl","summary":"The nt_pinfo command obtains and displays information about threads.","url":"https://d3codex.com/tcl/nt-pinfo-command/","api":"https://d3codex.com/api/topics/tcl/nt-pinfo-command.json"},{"slug":"tcl/nt-rel-tcp-command","title":"nt_rel-tcp command","category":"TCL","categorySlug":"tcl","summary":"The nt_rel-tcp command releases memory and closes tcp.","url":"https://d3codex.com/tcl/nt-rel-tcp-command/","api":"https://d3codex.com/api/topics/tcl/nt-rel-tcp-command.json"},{"slug":"tcl/nt-resize-command","title":"nt_resize command","category":"TCL","categorySlug":"tcl","summary":"The nt_resize command starts the FSI file resizing process. This command is executed at coldstart time to restart any resizing commands which were interrupted by a shutdown. It can also be called from TCL to resize files in real time.","url":"https://d3codex.com/tcl/nt-resize-command/","api":"https://d3codex.com/api/topics/tcl/nt-resize-command.json"},{"slug":"tcl/nt-resize-menu-command","title":"nt_resize-menu command","category":"TCL","categorySlug":"tcl","summary":"The nt_resize-menu command demonstrates the functionality of the four FSI utilities supplied by Rocket.","url":"https://d3codex.com/tcl/nt-resize-menu-command/","api":"https://d3codex.com/api/topics/tcl/nt-resize-menu-command.json"},{"slug":"tcl/nt-restart-odbc","title":"nt_restart_odbc","category":"TCL","categorySlug":"tcl","summary":"Stops or restarts the ODBC server. Typically used after configuring the Log Tracing Messages, Trace File and Flush Period values in the D3 Connect tab of the D3 Device Manager to enable D3 ODBC server tracing and debugging. Note that existing ODBC connections will be intact after nt_restart-odbc is used.","url":"https://d3codex.com/tcl/nt-restart-odbc/","api":"https://d3codex.com/api/topics/tcl/nt-restart-odbc.json"},{"slug":"tcl/nt-telnetdisc-command","title":"nt_telnetdisc command","category":"TCL","categorySlug":"tcl","summary":"The nt_telnetdisc command inquires/sets/resets the Telnet disconnect feature.","url":"https://d3codex.com/tcl/nt-telnetdisc-command/","api":"https://d3codex.com/api/topics/tcl/nt-telnetdisc-command.json"},{"slug":"tcl/nt-upgrade-command","title":"nt_upgrade command","category":"TCL","categorySlug":"tcl","summary":"The nt_upgrade command upgrades any d3 dataset with current changes. It first runs a pre-upgrade routine, then the upgrade, and finally a nt_postupgrade procedure. All D3 processes must be logged off.","url":"https://d3codex.com/tcl/nt-upgrade-command/","api":"https://d3codex.com/api/topics/tcl/nt-upgrade-command.json"},{"slug":"tcl/ntlfs-macro","title":"ntlfs macro","category":"TCL","categorySlug":"tcl","summary":"The ntlfs macro contains the AQL sentence which uses the dm,FileOfFiles file.","url":"https://d3codex.com/tcl/ntlfs-macro/","api":"https://d3codex.com/api/topics/tcl/ntlfs-macro.json"},{"slug":"tcl/odbc-setup-command","title":"odbc-setup command","category":"TCL","categorySlug":"tcl","summary":"The odbc-setup utility allows you to start, stop, and configure the ODBC server. Additionally, the current server status and version can be displayed.","url":"https://d3codex.com/tcl/odbc-setup-command/","api":"https://d3codex.com/api/topics/tcl/odbc-setup-command.json"},{"slug":"tcl/off-command-tcl-commands","title":"off command (TCL commands)","category":"TCL","categorySlug":"tcl","summary":"The off command stops processing at all levels on the current line and returns control to the initial logon prompt. This command is also valid from the system (virtual) debugger and the FlashBASIC debugger.","url":"https://d3codex.com/tcl/off-command-tcl-commands/","api":"https://d3codex.com/api/topics/tcl/off-command-tcl-commands.json"},{"slug":"tcl/okidata-command","title":"okidata command","category":"TCL","categorySlug":"tcl","summary":"The okidata BASIC program changes characteristics on Okidata printers.","url":"https://d3codex.com/tcl/okidata-command/","api":"https://d3codex.com/api/topics/tcl/okidata-command.json"},{"slug":"tcl/onneterror-command","title":"onneterror command","category":"TCL","categorySlug":"tcl","summary":"onneterror is a globally cataloged subroutine that can be called from the FSI when a network error occurs during FlashBASIC file I/Os. This allows users to break out of the error and customize the subroutine.","url":"https://d3codex.com/tcl/onneterror-command/","api":"https://d3codex.com/api/topics/tcl/onneterror-command.json"},{"slug":"tcl/op-command","title":"op command","category":"TCL","categorySlug":"tcl","summary":"The op command invokes the Output processor on specified items.","url":"https://d3codex.com/tcl/op-command/","api":"https://d3codex.com/api/topics/tcl/op-command.json"},{"slug":"tcl/options-spooler","title":"Options (Spooler)","category":"TCL","categorySlug":"tcl","summary":"Spooler options can be specified to most spooler commands. Some have numeric arguments.","url":"https://d3codex.com/tcl/options-spooler/","api":"https://d3codex.com/api/topics/tcl/options-spooler.json"},{"slug":"tcl/options-tcl","title":"Options (TCL)","category":"TCL","categorySlug":"tcl","summary":"The print (p and no pause (n options are the only standard options available to every TCL command.","url":"https://d3codex.com/tcl/options-tcl/","api":"https://d3codex.com/api/topics/tcl/options-tcl.json"},{"slug":"tcl/overflow-command","title":"overflow command","category":"TCL","categorySlug":"tcl","summary":"The overflow command displays the system overflow table which contains the addresses of available disk frames. All unused frames are available for use by the spooler, the D3 file system, and the process workspace.","url":"https://d3codex.com/tcl/overflow-command/","api":"https://d3codex.com/api/topics/tcl/overflow-command.json"},{"slug":"tcl/ovf-monitor-command","title":"ovf-monitor command","category":"TCL","categorySlug":"tcl","summary":"The ovf-monitor command monitors and displays overflow consumption on a port by port basis.","url":"https://d3codex.com/tcl/ovf-monitor-command/","api":"https://d3codex.com/api/topics/tcl/ovf-monitor-command.json"},{"slug":"tcl/p-command-tcl-commands","title":"p command (TCL commands)","category":"TCL","categorySlug":"tcl","summary":"The p command turns on or off the display of terminal output. When activated, the output from any process does not display on the screen.","url":"https://d3codex.com/tcl/p-command-tcl-commands/","api":"https://d3codex.com/api/topics/tcl/p-command-tcl-commands.json"},{"slug":"tcl/paint-command","title":"paint command","category":"TCL","categorySlug":"tcl","summary":"The paint command displays items to the screen or printer in Update processor format.","url":"https://d3codex.com/tcl/paint-command/","api":"https://d3codex.com/api/topics/tcl/paint-command.json"},{"slug":"tcl/paragraph","title":"Paragraph","category":"TCL","categorySlug":"tcl","summary":"The paragraph is a macro language allowing execution of TCL statements, looping structures, data stacking, screen input and output, and branching.","url":"https://d3codex.com/tcl/paragraph/","api":"https://d3codex.com/api/topics/tcl/paragraph.json"},{"slug":"tcl/password-command","title":"password command","category":"TCL","categorySlug":"tcl","summary":"The password BASIC program allows adding, changing or removing a user or account password.","url":"https://d3codex.com/tcl/password-command/","api":"https://d3codex.com/api/topics/tcl/password-command.json"},{"slug":"tcl/penv-command","title":"penv command","category":"TCL","categorySlug":"tcl","summary":"The penv BASIC program displays a list of all user D3 shell variables and the contents of those variables.","url":"https://d3codex.com/tcl/penv-command/","api":"https://d3codex.com/api/topics/tcl/penv-command.json"},{"slug":"tcl/peqs","title":"peqs","category":"TCL","categorySlug":"tcl","summary":"The peqs super Q-pointer allows access to spooler jobs as if they were standard files.","url":"https://d3codex.com/tcl/peqs/","api":"https://d3codex.com/api/topics/tcl/peqs.json"},{"slug":"tcl/phantom-reset-command","title":"phantom-reset command","category":"TCL","categorySlug":"tcl","summary":"The phantom-reset BASIC program resets the specified phantom lines to available status. If a UNIX process for a phantom is gone (PID 0), it recreates the process and ensures that the port on the D3 side is available to handle the next request.","url":"https://d3codex.com/tcl/phantom-reset-command/","api":"https://d3codex.com/api/topics/tcl/phantom-reset-command.json"},{"slug":"tcl/phantom-status-command","title":"phantom-status command","category":"TCL","categorySlug":"tcl","summary":"The phantom-status BASIC program displays all phantom lines and whether they are busy, available, or transaction logger.","url":"https://d3codex.com/tcl/phantom-status-command/","api":"https://d3codex.com/api/topics/tcl/phantom-status-command.json"},{"slug":"tcl/pibstat-command","title":"pibstat command","category":"TCL","categorySlug":"tcl","summary":"The pibstat command in the DM account displays the current PIB status bit settings for a specified value.","url":"https://d3codex.com/tcl/pibstat-command/","api":"https://d3codex.com/api/topics/tcl/pibstat-command.json"},{"slug":"tcl/pid-command","title":"pid command","category":"TCL","categorySlug":"tcl","summary":"The pid BASIC program displays the UNIX PID of a D3 process.","url":"https://d3codex.com/tcl/pid-command/","api":"https://d3codex.com/api/topics/tcl/pid-command.json"},{"slug":"tcl/pitch-compile-command","title":"pitch-compile command","category":"TCL","categorySlug":"tcl","summary":"The pitch-compile BASIC program compiles a pitch file found in the dm,fonts,pitch file.","url":"https://d3codex.com/tcl/pitch-compile-command/","api":"https://d3codex.com/api/topics/tcl/pitch-compile-command.json"},{"slug":"tcl/pitch-table-command","title":"pitch-table command","category":"TCL","categorySlug":"tcl","summary":"The pitch-table BASIC program builds a pitch table for a font file in the dm,fonts,descr file.","url":"https://d3codex.com/tcl/pitch-table-command/","api":"https://d3codex.com/api/topics/tcl/pitch-table-command.json"},{"slug":"tcl/poke-command","title":"poke command","category":"TCL","categorySlug":"tcl","summary":"The poke BASIC program sends either a string of characters, or one or more TCL commands to the input buffer of another port.","url":"https://d3codex.com/tcl/poke-command/","api":"https://d3codex.com/api/topics/tcl/poke-command.json"},{"slug":"tcl/power-off-command","title":"power-off command","category":"TCL","categorySlug":"tcl","summary":"The power-off command in the DM account brings the system to an orderly shutdown by logging off all users, flushing memory to disk, and parking the disk heads prior to halting the system.","url":"https://d3codex.com/tcl/power-off-command/","api":"https://d3codex.com/api/topics/tcl/power-off-command.json"},{"slug":"tcl/pr-spool-job-command","title":"pr-spool-job command","category":"TCL","categorySlug":"tcl","summary":"The pr-spool-job command respools a spooler hold job. The user can select a one-time sp-assignment for this job by placing the desired sp-assign options after the open parenthesis at TCL.","url":"https://d3codex.com/tcl/pr-spool-job-command/","api":"https://d3codex.com/api/topics/tcl/pr-spool-job-command.json"},{"slug":"tcl/prime-command","title":"prime command","category":"TCL","categorySlug":"tcl","summary":"The prime BASIC program calculates the next higher and lower prime number from a specified number.","url":"https://d3codex.com/tcl/prime-command/","api":"https://d3codex.com/api/topics/tcl/prime-command.json"},{"slug":"tcl/print-err-command","title":"print-err command","category":"TCL","categorySlug":"tcl","summary":"The print-err command provides a means of displaying messages from the messages file in their output format.","url":"https://d3codex.com/tcl/print-err-command/","api":"https://d3codex.com/api/topics/tcl/print-err-command.json"},{"slug":"tcl/print-error-command","title":"print-error command","category":"TCL","categorySlug":"tcl","summary":"The print-error BASIC program prints an error message from stacked data statements.","url":"https://d3codex.com/tcl/print-error-command/","api":"https://d3codex.com/api/topics/tcl/print-error-command.json"},{"slug":"tcl/print-filter-command","title":"print-filter command","category":"TCL","categorySlug":"tcl","summary":"The print-filter command controls the ways attribute and value marks are displayed or printed.","url":"https://d3codex.com/tcl/print-filter-command/","api":"https://d3codex.com/api/topics/tcl/print-filter-command.json"},{"slug":"tcl/printronix-command","title":"printronix command","category":"TCL","categorySlug":"tcl","summary":"The printronix BASIC program sets the vertical form length unit (VFU) for Printronix printers only. The VFU setting includes a page length, skip perfs, and vertical tabs.","url":"https://d3codex.com/tcl/printronix-command/","api":"https://d3codex.com/api/topics/tcl/printronix-command.json"},{"slug":"tcl/prompt-statement","title":"prompt statement","category":"TCL","categorySlug":"tcl","summary":"The prompt statement in a macro prompts the user with a specified text string. The user is then given the option to either continue (by entering c, or stopping the process (by entering q). No other characters are allowed.","url":"https://d3codex.com/tcl/prompt-statement/","api":"https://d3codex.com/api/topics/tcl/prompt-statement.json"},{"slug":"tcl/psh-command","title":"psh command","category":"TCL","categorySlug":"tcl","summary":"The psh BASIC program executes a UNIX command and captures the results in a D3 item. This command is an alternative to the ! command, which allows capturing the result of the UNIX command into a D3 item.","url":"https://d3codex.com/tcl/psh-command/","api":"https://d3codex.com/api/topics/tcl/psh-command.json"},{"slug":"tcl/psr-command","title":"psr command","category":"TCL","categorySlug":"tcl","summary":"The psr BASIC program displays formatted output of the status of the currently active UNIX and/or D3 processes.","url":"https://d3codex.com/tcl/psr-command/","api":"https://d3codex.com/api/topics/tcl/psr-command.json"},{"slug":"tcl/ptype-command","title":"ptype command","category":"TCL","categorySlug":"tcl","summary":"The ptype command returns whether a BASIC program is a main program or a subroutine.","url":"https://d3codex.com/tcl/ptype-command/","api":"https://d3codex.com/api/topics/tcl/ptype-command.json"},{"slug":"tcl/pverify-command","title":"pverify command","category":"TCL","categorySlug":"tcl","summary":"The pverify command verifies the checksum for the object code of a BASIC program.","url":"https://d3codex.com/tcl/pverify-command/","api":"https://d3codex.com/api/topics/tcl/pverify-command.json"},{"slug":"tcl/qselect-command","title":"qselect command","category":"TCL","categorySlug":"tcl","summary":"The qselect command creates a list from the specified file reference and item list, similar to the get-list command.","url":"https://d3codex.com/tcl/qselect-command/","api":"https://d3codex.com/api/topics/tcl/qselect-command.json"},{"slug":"tcl/r-command-mvbase","title":".r command (mvBase)","category":"TCL","categorySlug":"tcl","summary":"The .r command executes stack statements stored in a file item.","url":"https://d3codex.com/tcl/r-command-mvbase/","api":"https://d3codex.com/api/topics/tcl/r-command-mvbase.json"},{"slug":"tcl/reblock-ovf-command","title":"reblock-ovf command","category":"TCL","categorySlug":"tcl","summary":"The reblock-ovf command forces contiguous overflow blocks that exist in different internal tables to be compared and combined if possible.","url":"https://d3codex.com/tcl/reblock-ovf-command/","api":"https://d3codex.com/api/topics/tcl/reblock-ovf-command.json"},{"slug":"tcl/reboot-command","title":"reboot command","category":"TCL","categorySlug":"tcl","summary":"The reboot command reloads the operating system from a currently executing system.","url":"https://d3codex.com/tcl/reboot-command/","api":"https://d3codex.com/api/topics/tcl/reboot-command.json"},{"slug":"tcl/reclaim-ovf-command","title":"reclaim-ovf command","category":"TCL","categorySlug":"tcl","summary":"The reclaim-ovf BASIC program allows the user to recover all frames not used by the system to the overflow space, thus eliminating the necessity of a file-save/restore. The number of lost frames that are recovered displays at the completion of the frame scan process.","url":"https://d3codex.com/tcl/reclaim-ovf-command/","api":"https://d3codex.com/api/topics/tcl/reclaim-ovf-command.json"},{"slug":"tcl/recover-item-command","title":"recover-item command","category":"TCL","categorySlug":"tcl","summary":"The recover-item command recovers the last item deleted by the CTRL+XO command in the Update processor. It also recovers the last item that was exited without filing.","url":"https://d3codex.com/tcl/recover-item-command/","api":"https://d3codex.com/api/topics/tcl/recover-item-command.json"},{"slug":"tcl/rem-statement","title":"rem statement","category":"TCL","categorySlug":"tcl","summary":"The rem statement, used in a macro, designates a remark statement and all text which follows on the same line is ignored.","url":"https://d3codex.com/tcl/rem-statement/","api":"https://d3codex.com/api/topics/tcl/rem-statement.json"},{"slug":"tcl/remote-cache-command","title":"remote-cache command","category":"TCL","categorySlug":"tcl","summary":"The remote-cache BASIC program increases the performance of updates over a network by sending groups of updates at a time.","url":"https://d3codex.com/tcl/remote-cache-command/","api":"https://d3codex.com/api/topics/tcl/remote-cache-command.json"},{"slug":"tcl/rename-command","title":"rename command","category":"TCL","categorySlug":"tcl","summary":"The rename command renames both the dictionary and data portions of the file. It can also be used to rename only the dictionary or data portions of the file by specifying DICT or DATA in the command line.","url":"https://d3codex.com/tcl/rename-command/","api":"https://d3codex.com/api/topics/tcl/rename-command.json"},{"slug":"tcl/rename-file-command","title":"rename-file command","category":"TCL","categorySlug":"tcl","summary":"The rename-file BASIC program changes the name of a file, both in the master dictionary and in the dictionary of the designated file reference.","url":"https://d3codex.com/tcl/rename-file-command/","api":"https://d3codex.com/api/topics/tcl/rename-file-command.json"},{"slug":"tcl/renumber-command","title":"renumber command","category":"TCL","categorySlug":"tcl","summary":"The renumber command is equivalent to running the bformat command, with the r option and a control table specifying no indentation.","url":"https://d3codex.com/tcl/renumber-command/","api":"https://d3codex.com/api/topics/tcl/renumber-command.json"},{"slug":"tcl/reset-port-command","title":"reset-port command","category":"TCL","categorySlug":"tcl","summary":"The reset-port BASIC program restarts suspended output and drains both the input and output terminal buffers.","url":"https://d3codex.com/tcl/reset-port-command/","api":"https://d3codex.com/api/topics/tcl/reset-port-command.json"},{"slug":"tcl/reset-user-command","title":"reset-user command","category":"TCL","categorySlug":"tcl","summary":"The reset-user BASIC program reinitializes a process. It is also called by logoff in a worst-case scenario.","url":"https://d3codex.com/tcl/reset-user-command/","api":"https://d3codex.com/api/topics/tcl/reset-user-command.json"},{"slug":"tcl/resize-command","title":"resize command","category":"TCL","categorySlug":"tcl","summary":"The resize command resizes a file to the preferred modulo, and increases or decreases the apparent contiguous portion (or modulo) of the specified file without requiring a file-restore. It either adds or releases the amount of overflow necessary to reach the new modulo and rehashes all of the items. The rehashing is done by groups and the current relative group being rehashed displays on the screen.","url":"https://d3codex.com/tcl/resize-command/","api":"https://d3codex.com/api/topics/tcl/resize-command.json"},{"slug":"tcl/restore-accounts-command","title":"restore-accounts command","category":"TCL","categorySlug":"tcl","summary":"The restore-accounts BASIC program restores all accounts that do not already exist on the system from the attached file-save tape or a tape created by an account-save with an active list of accounts. File statistics can be built with the restore operation. It is therefore not necessary to do a file-save after a restore operation to create file statistics.","url":"https://d3codex.com/tcl/restore-accounts-command/","api":"https://d3codex.com/api/topics/tcl/restore-accounts-command.json"},{"slug":"tcl/rmbi-command","title":"rmbi command","category":"TCL","categorySlug":"tcl","summary":"The rmbi command removes one or more functions from the list of UNIX or C built-in functions.","url":"https://d3codex.com/tcl/rmbi-command/","api":"https://d3codex.com/api/topics/tcl/rmbi-command.json"},{"slug":"tcl/run-command","title":"run command","category":"TCL","categorySlug":"tcl","summary":"The run command invokes BASIC/FlashBASIC run time, which attempts to load and execute a compiled BASIC/FlashBASIC program.","url":"https://d3codex.com/tcl/run-command/","api":"https://d3codex.com/api/topics/tcl/run-command.json"},{"slug":"tcl/run-list-command","title":"run-list command","category":"TCL","categorySlug":"tcl","summary":"The run-list BASIC program runs a series of BASIC programs. As each one concludes, the next program is automatically executed.","url":"https://d3codex.com/tcl/run-list-command/","api":"https://d3codex.com/api/topics/tcl/run-list-command.json"},{"slug":"tcl/run-nf-command","title":"run.nf command","category":"TCL","categorySlug":"tcl","summary":"The run.nf command invokes BASIC run time (not FlashBASIC), which attempts to load and execute a compiled BASIC program, even if compiled with FlashBASIC.","url":"https://d3codex.com/tcl/run-nf-command/","api":"https://d3codex.com/api/topics/tcl/run-nf-command.json"},{"slug":"tcl/runoff-command-tcl-commands","title":"runoff command","category":"TCL","categorySlug":"tcl","summary":"The runoff command facilitates the preparation and maintenance of textual material such as memos, manuals, and so on.","url":"https://d3codex.com/tcl/runoff-command-tcl-commands/","api":"https://d3codex.com/api/topics/tcl/runoff-command-tcl-commands.json"},{"slug":"tcl/s-dump-command","title":"s-dump command","category":"TCL","categorySlug":"tcl","summary":"The s-dump command writes items from a given file to the attached peripheral storage device in sorted order. The heading or header modifier allows specifying the contents of the tape label written to the tape prior to the dump. The tape must already be at load point in order to write the tape label. If no selection criteria are specified, the entire file is written.","url":"https://d3codex.com/tcl/s-dump-command/","api":"https://d3codex.com/api/topics/tcl/s-dump-command.json"},{"slug":"tcl/sample-command","title":"sample command","category":"TCL","categorySlug":"tcl","summary":"The sample command creates a temporary select-list of the first n items in a file that match the specified criteria. This command is useful when testing a small number of items. For example, testing 100 items in a file rather than the entire file.","url":"https://d3codex.com/tcl/sample-command/","api":"https://d3codex.com/api/topics/tcl/sample-command.json"},{"slug":"tcl/save-command","title":"save command","category":"TCL","categorySlug":"tcl","summary":"The save command invokes the backup procedure to save the entire file system, an individual account, or to perform an incremental save. It is the process invoked by the account-save and file-save commands.","url":"https://d3codex.com/tcl/save-command/","api":"https://d3codex.com/api/topics/tcl/save-command.json"},{"slug":"tcl/save-list-command","title":"save-list command","category":"TCL","categorySlug":"tcl","summary":"The save-list command writes the list of item-IDs generated by a select, sselect, qselect, or get-list command.","url":"https://d3codex.com/tcl/save-list-command/","api":"https://d3codex.com/api/topics/tcl/save-list-command.json"},{"slug":"tcl/screen-input-output","title":"Screen input/output","category":"TCL","categorySlug":"tcl","summary":"It is possible to solicit input and display output in a paragraph. To do simple output, use the display statement with a string argument. To do simple input, embed the desired prompt within << and >> (double angle brackets). For example, the line display <<Enter name>> prompts Enter name> and then prints the name.","url":"https://d3codex.com/tcl/screen-input-output/","api":"https://d3codex.com/api/topics/tcl/screen-input-output.json"},{"slug":"tcl/search-command","title":"search command","category":"TCL","categorySlug":"tcl","summary":"The search command searches a file for the existence of one or more strings of characters in any attribute and optionally creates and saves a list.","url":"https://d3codex.com/tcl/search-command/","api":"https://d3codex.com/api/topics/tcl/search-command.json"},{"slug":"tcl/search-system-command","title":"search-system command","category":"TCL","categorySlug":"tcl","summary":"The search-system BASIC program searches every file in the D3 file system for the existence of one or more strings of characters in any attribute and optionally creates and saves a list. If a master dictionary name is provided, only that account is searched. The search-system command searches remote accounts (Q-pointers) in the mds.","url":"https://d3codex.com/tcl/search-system-command/","api":"https://d3codex.com/api/topics/tcl/search-system-command.json"},{"slug":"tcl/sel-restore-command","title":"sel-restore command","category":"TCL","categorySlug":"tcl","summary":"The sel-restore command selectively restores items from either a file-save, account-save, incremental save, or transaction log media to a specific file.","url":"https://d3codex.com/tcl/sel-restore-command/","api":"https://d3codex.com/api/topics/tcl/sel-restore-command.json"},{"slug":"tcl/send-message-command","title":"send-message command","category":"TCL","categorySlug":"tcl","summary":"The send-message BASIC program directs a text message to a specific port, a specific user-ID, all current users, or every device attached to the system.","url":"https://d3codex.com/tcl/send-message-command/","api":"https://d3codex.com/api/topics/tcl/send-message-command.json"},{"slug":"tcl/set-8mm-command","title":"set-8mm command","category":"TCL","categorySlug":"tcl","summary":"The set-8mm command sets the 8mm data cartridge as the tape device, by invoking the set-device command and passing in the argument 8mm and an i option. The default block size is 16384.","url":"https://d3codex.com/tcl/set-8mm-command/","api":"https://d3codex.com/api/topics/tcl/set-8mm-command.json"},{"slug":"tcl/set-abs-command","title":"set-abs command","category":"TCL","categorySlug":"tcl","summary":"The set-abs command designates a file as the data section associated to the boot ABS, or control the boot ABS specifications.","url":"https://d3codex.com/tcl/set-abs-command/","api":"https://d3codex.com/api/topics/tcl/set-abs-command.json"},{"slug":"tcl/set-active-update-command","title":"set-active-update command","category":"TCL","categorySlug":"tcl","summary":"The set-active-update command ensures that data fragments are cleaned-up from file-system frames whenever data is deleted from a file. Additionally, frames that are being returned to local overflow are also scrubbed.","url":"https://d3codex.com/tcl/set-active-update-command/","api":"https://d3codex.com/api/topics/tcl/set-active-update-command.json"},{"slug":"tcl/set-auto-disconnect-command","title":"set-auto-disconnect command","category":"TCL","categorySlug":"tcl","summary":"The set-auto-disconnect command goes through the SECURITY-CONTROL file and sets the auto-disconnect value for all PIBs at system-coldstart.","url":"https://d3codex.com/tcl/set-auto-disconnect-command/","api":"https://d3codex.com/api/topics/tcl/set-auto-disconnect-command.json"},{"slug":"tcl/set-batch-command","title":"set-batch command","category":"TCL","categorySlug":"tcl","summary":"The set-batch BASIC program displays or changes the current sensitivity value for the interactive/batch trigger.","url":"https://d3codex.com/tcl/set-batch-command/","api":"https://d3codex.com/api/topics/tcl/set-batch-command.json"},{"slug":"tcl/set-batchdly-command","title":"set-batchdly command","category":"TCL","categorySlug":"tcl","summary":"The set-batchdly BASIC program displays or changes the current sensitivity value for the interactive/batch trigger, as well as the weight of the trigger and the trigger cancel value.","url":"https://d3codex.com/tcl/set-batchdly-command/","api":"https://d3codex.com/api/topics/tcl/set-batchdly-command.json"},{"slug":"tcl/set-baud-command","title":"set-baud command","category":"TCL","categorySlug":"tcl","summary":"The set-baud BASIC program sets the baud rate for the current port or for another port.","url":"https://d3codex.com/tcl/set-baud-command/","api":"https://d3codex.com/api/topics/tcl/set-baud-command.json"},{"slug":"tcl/set-bootsleep-command","title":"set-bootsleep command","category":"TCL","categorySlug":"tcl","summary":"The set-bootsleep BASIC program sets the delay (in seconds) before the system is booted automatically.","url":"https://d3codex.com/tcl/set-bootsleep-command/","api":"https://d3codex.com/api/topics/tcl/set-bootsleep-command.json"},{"slug":"tcl/set-break-command","title":"set-break command","category":"TCL","categorySlug":"tcl","summary":"The set-break BASIC program displays or changes the value of the break character used as an optional substitute for the BREAK key for the current port.","url":"https://d3codex.com/tcl/set-break-command/","api":"https://d3codex.com/api/topics/tcl/set-break-command.json"},{"slug":"tcl/set-cmem-command","title":"set-cmem command","category":"TCL","categorySlug":"tcl","summary":"The set-cmem BASIC program displays or changes the size of the data area used for the BASIC/C or BASIC/GM Assembler interface for the current process.","url":"https://d3codex.com/tcl/set-cmem-command/","api":"https://d3codex.com/api/topics/tcl/set-cmem-command.json"},{"slug":"tcl/set-command","title":"set command","category":"TCL","categorySlug":"tcl","summary":"The set BASIC program modifies the value of a D3 user shell variable.","url":"https://d3codex.com/tcl/set-command/","api":"https://d3codex.com/api/topics/tcl/set-command.json"},{"slug":"tcl/set-compat-command","title":"set-compat command","category":"TCL","categorySlug":"tcl","summary":"The set-compat command allows a user (port), or the global environment, to be set to a particular Pick compatible environment. Using this command allows functionality to be added to D3 that is specific to a particular Pick compatible environment.","url":"https://d3codex.com/tcl/set-compat-command/","api":"https://d3codex.com/api/topics/tcl/set-compat-command.json"},{"slug":"tcl/set-compiler-command","title":"set-compiler command","category":"TCL","categorySlug":"tcl","summary":"The set-compiler BASIC program sets backward BASIC compiler compatibility.","url":"https://d3codex.com/tcl/set-compiler-command/","api":"https://d3codex.com/api/topics/tcl/set-compiler-command.json"},{"slug":"tcl/set-date-command","title":"set-date command","category":"TCL","categorySlug":"tcl","summary":"The set-date BASIC program sets the system software date, and optionally the system hardware clock.","url":"https://d3codex.com/tcl/set-date-command/","api":"https://d3codex.com/api/topics/tcl/set-date-command.json"},{"slug":"tcl/set-date-eur-command","title":"set-date-eur command","category":"TCL","categorySlug":"tcl","summary":"The set-date-eur command toggles the standard (American) date format to European/International format: dd/mm/yy for input and output purposes.","url":"https://d3codex.com/tcl/set-date-eur-command/","api":"https://d3codex.com/api/topics/tcl/set-date-eur-command.json"},{"slug":"tcl/set-date-format-command","title":"set-date-format command","category":"TCL","categorySlug":"tcl","summary":"The set-date-format command allows changing the domestic time/date format using items from the date-format file.","url":"https://d3codex.com/tcl/set-date-format-command/","api":"https://d3codex.com/api/topics/tcl/set-date-format-command.json"},{"slug":"tcl/set-date-std-command","title":"set-date-std command","category":"TCL","categorySlug":"tcl","summary":"The set-date-std command toggles the European/International date format to standard (American) format: mm/dd/yy for input and output.","url":"https://d3codex.com/tcl/set-date-std-command/","api":"https://d3codex.com/api/topics/tcl/set-date-std-command.json"},{"slug":"tcl/set-date-window-command","title":"set-date-window command","category":"TCL","categorySlug":"tcl","summary":"The set-date-window command allows specifying the rollover point on your system.","url":"https://d3codex.com/tcl/set-date-window-command/","api":"https://d3codex.com/api/topics/tcl/set-date-window-command.json"},{"slug":"tcl/set-decimal-command","title":"set-decimal command","category":"TCL","categorySlug":"tcl","summary":"The set-decimal command designates that a numeric expression of 1 is equal to 100 units.","url":"https://d3codex.com/tcl/set-decimal-command/","api":"https://d3codex.com/api/topics/tcl/set-decimal-command.json"},{"slug":"tcl/set-def-tape-blk-command","title":"set-def-tape-blk command","category":"TCL","categorySlug":"tcl","summary":"There are two methods to configure the drive in variable block size mode:","url":"https://d3codex.com/tcl/set-def-tape-blk-command/","api":"https://d3codex.com/api/topics/tcl/set-def-tape-blk-command.json"},{"slug":"tcl/set-device-command","title":"set-device command","category":"TCL","categorySlug":"tcl","summary":"The set-device FlashBASIC program attaches the SCT, floppy disk, half-inch, or special devices.","url":"https://d3codex.com/tcl/set-device-command/","api":"https://d3codex.com/api/topics/tcl/set-device-command.json"},{"slug":"tcl/set-dozens-command","title":"set-dozens command","category":"TCL","categorySlug":"tcl","summary":"The set-dozens command designates that a numeric expression of 1 is equal to 12 units.","url":"https://d3codex.com/tcl/set-dozens-command/","api":"https://d3codex.com/api/topics/tcl/set-dozens-command.json"},{"slug":"tcl/set-dptr-command","title":"set-dptr command","category":"TCL","categorySlug":"tcl","summary":"The set-dptr BASIC program changes the first attribute of file-defining D-pointers, to set or reset special types, such as dx or dy.","url":"https://d3codex.com/tcl/set-dptr-command/","api":"https://d3codex.com/api/topics/tcl/set-dptr-command.json"},{"slug":"tcl/set-esc-command","title":"set-esc command","category":"TCL","categorySlug":"tcl","summary":"The set-esc BASIC program specifies the value of the key to treat as the ESC key. This key subsequently pushes a level when pressed.","url":"https://d3codex.com/tcl/set-esc-command/","api":"https://d3codex.com/api/topics/tcl/set-esc-command.json"},{"slug":"tcl/set-file-command","title":"set-file command","category":"TCL","categorySlug":"tcl","summary":"The set-file BASIC program creates or updates the synonym-defining item called qfile in the master dictionary of the current account.","url":"https://d3codex.com/tcl/set-file-command/","api":"https://d3codex.com/api/topics/tcl/set-file-command.json"},{"slug":"tcl/set-floppy-command","title":"set-floppy command","category":"TCL","categorySlug":"tcl","summary":"The set-floppy command attaches the first floppy (in the list-device listing) drive to the current process for subsequent input or output activity. The drive indicator and density are indicated with the options provided.","url":"https://d3codex.com/tcl/set-floppy-command/","api":"https://d3codex.com/api/topics/tcl/set-floppy-command.json"},{"slug":"tcl/set-flush-command","title":"set-flush command","category":"TCL","categorySlug":"tcl","summary":"The set-flush BASIC program displays or changes the value of the period of the flush and of the forced flush.","url":"https://d3codex.com/tcl/set-flush-command/","api":"https://d3codex.com/api/topics/tcl/set-flush-command.json"},{"slug":"tcl/set-half-command","title":"set-half command","category":"TCL","categorySlug":"tcl","summary":"The set-half command attaches the 1/2-inch tape drive to the current process for subsequent input or output activity. Change the default block size with the t-att command.","url":"https://d3codex.com/tcl/set-half-command/","api":"https://d3codex.com/api/topics/tcl/set-half-command.json"},{"slug":"tcl/set-imap-command","title":"set-imap command","category":"TCL","categorySlug":"tcl","summary":"The set-imap BASIC program defines a keyboard input and/or a terminal output translation table, through which any sequence of keyboard input and terminal output characters can be translated into any other sequence of characters.","url":"https://d3codex.com/tcl/set-imap-command/","api":"https://d3codex.com/api/topics/tcl/set-imap-command.json"},{"slug":"tcl/set-incremental-command","title":"set-incremental command","category":"TCL","categorySlug":"tcl","summary":"The set-incremental command enables or disables the incremental save feature.","url":"https://d3codex.com/tcl/set-incremental-command/","api":"https://d3codex.com/api/topics/tcl/set-incremental-command.json"},{"slug":"tcl/set-iomap-command","title":"set-iomap command","category":"TCL","categorySlug":"tcl","summary":"The set-iomap BASIC program allows translatable input and output for each port on the system.","url":"https://d3codex.com/tcl/set-iomap-command/","api":"https://d3codex.com/api/topics/tcl/set-iomap-command.json"},{"slug":"tcl/set-kbrd-command","title":"set-kbrd command","category":"TCL","categorySlug":"tcl","summary":"For Linux only. Use the set-kbrd BASIC program to change between standard international keyboard maps for line 0 (zero). This command is used from the dm account.","url":"https://d3codex.com/tcl/set-kbrd-command/","api":"https://d3codex.com/api/topics/tcl/set-kbrd-command.json"},{"slug":"tcl/set-num-format-command","title":"set-num-format command","category":"TCL","categorySlug":"tcl","summary":"The set-num-format command changes the currency sign, thousand, and decimal point in an m conversion, at a local or global level. All of these signs must be a single character. The defaults for these are the previous settings.","url":"https://d3codex.com/tcl/set-num-format-command/","api":"https://d3codex.com/api/topics/tcl/set-num-format-command.json"},{"slug":"tcl/set-opendb-password-command","title":"set-opendb-password command","category":"TCL","categorySlug":"tcl","summary":"The set-opendb-password command sets or removes an encrypted password on an OpenDB host. Passwords are saved in attribute 3 of the hosts file.","url":"https://d3codex.com/tcl/set-opendb-password-command/","api":"https://d3codex.com/api/topics/tcl/set-opendb-password-command.json"},{"slug":"tcl/set-overflow-id-command","title":"set-overflow-id command","category":"TCL","categorySlug":"tcl","summary":"The set-overflow-id command toggles the overflow ID signature on and off.","url":"https://d3codex.com/tcl/set-overflow-id-command/","api":"https://d3codex.com/api/topics/tcl/set-overflow-id-command.json"},{"slug":"tcl/set-ovf-local-command","title":"set-ovf-local command","category":"TCL","categorySlug":"tcl","summary":"The set-ovf-local command sets and displays the local overflow cache size.","url":"https://d3codex.com/tcl/set-ovf-local-command/","api":"https://d3codex.com/api/topics/tcl/set-ovf-local-command.json"},{"slug":"tcl/set-ovf-reserve-command","title":"set-ovf-reserve command","category":"TCL","categorySlug":"tcl","summary":"The set-ovf-reserve command in the DM account, sets aside a specific number of frames as the spare tank in the event that the overflow table runs out of frames. The default is 1024 or .5% of your available disk space (maxfid), whichever is greater. When the set-ovf-reserve command is run, the system displays both the old and new reserve values.","url":"https://d3codex.com/tcl/set-ovf-reserve-command/","api":"https://d3codex.com/api/topics/tcl/set-ovf-reserve-command.json"},{"slug":"tcl/set-port-command","title":"set-port command","category":"TCL","categorySlug":"tcl","summary":"The term set-port BASIC program displays or changes the communication speed and protocol for a specified port or displays the current setting if none of the communication parameters are specified.","url":"https://d3codex.com/tcl/set-port-command/","api":"https://d3codex.com/api/topics/tcl/set-port-command.json"},{"slug":"tcl/set-remote-close-command","title":"set-remote-close command","category":"TCL","categorySlug":"tcl","summary":"The set-remote-close command toggles on and off the BASIC close command’s ability to close remote files.","url":"https://d3codex.com/tcl/set-remote-close-command/","api":"https://d3codex.com/api/topics/tcl/set-remote-close-command.json"},{"slug":"tcl/set-remote-user-command","title":"set-remote-user command","category":"TCL","categorySlug":"tcl","summary":"The set-remote-user BASIC program can be used to allow the local user to utilize a different user and/or password when connecting to a remote OSFI server which has been started with the a option to force user/password authorization.","url":"https://d3codex.com/tcl/set-remote-user-command/","api":"https://d3codex.com/api/topics/tcl/set-remote-user-command.json"},{"slug":"tcl/set-runaway-autoquit-command","title":"set-runaway-autoquit command","category":"TCL","categorySlug":"tcl","summary":"The set-runaway-autoquit command in the DM account automatically terminates the specified process in the event of an overflow runaway condition. If set-runaway-autoquit is not specified and an overflow runaway condition occurs, a prompt (Continue or Quit) displays instead. All overflow runaway conditions are logged to the errors file.","url":"https://d3codex.com/tcl/set-runaway-autoquit-command/","api":"https://d3codex.com/api/topics/tcl/set-runaway-autoquit-command.json"},{"slug":"tcl/set-runaway-limit-command","title":"set-runaway-limit command","category":"TCL","categorySlug":"tcl","summary":"The set-runaway-limit command in the DM account establishes the maximum number of frames allowed before an overflow runaway condition occurs. If the number of frames acquired by the specified process when either writing or retrieving an item reaches the specified limit, the system detects an overflow runaway condition and reports it. This command can be applied globally to all lines or locally to the current line. See set-runaway-autoquit command for more information.","url":"https://d3codex.com/tcl/set-runaway-limit-command/","api":"https://d3codex.com/api/topics/tcl/set-runaway-limit-command.json"},{"slug":"tcl/set-sct-command","title":"set-sct command","category":"TCL","categorySlug":"tcl","summary":"The set-sct command attaches the SCT drive to the current process. This must be executed before any other tape handling commands. This command is provided for compatibility.","url":"https://d3codex.com/tcl/set-sct-command/","api":"https://d3codex.com/api/topics/tcl/set-sct-command.json"},{"slug":"tcl/set-shutdown-delay-command","title":"set-shutdown-delay command","category":"TCL","categorySlug":"tcl","summary":"The set-shutdown-delay command is provided primarily for installations which have disk-caching hard-disk controllers. This provides time for the disk to flush.","url":"https://d3codex.com/tcl/set-shutdown-delay-command/","api":"https://d3codex.com/api/topics/tcl/set-shutdown-delay-command.json"},{"slug":"tcl/set-sound-command","title":"set-sound command","category":"TCL","categorySlug":"tcl","summary":"The set-sound BASIC program sets the system console sound level on port 0 only.","url":"https://d3codex.com/tcl/set-sound-command/","api":"https://d3codex.com/api/topics/tcl/set-sound-command.json"},{"slug":"tcl/set-sym-command","title":"set-sym command","category":"TCL","categorySlug":"tcl","summary":"The set-sym command indicates the symbol table to use for references to system variables from within the system, or virtual debugger.","url":"https://d3codex.com/tcl/set-sym-command/","api":"https://d3codex.com/api/topics/tcl/set-sym-command.json"},{"slug":"tcl/set-tapefile-command","title":"set-tapefile command","category":"TCL","categorySlug":"tcl","summary":"The set-tapefile command creates a dynamically defined pseudo tape.","url":"https://d3codex.com/tcl/set-tapefile-command/","api":"https://d3codex.com/api/topics/tcl/set-tapefile-command.json"},{"slug":"tcl/set-thousands-command","title":"set-thousands command","category":"TCL","categorySlug":"tcl","summary":"The set-thousands command designates that a numeric expression of 1 is equal to 1000 units.","url":"https://d3codex.com/tcl/set-thousands-command/","api":"https://d3codex.com/api/topics/tcl/set-thousands-command.json"},{"slug":"tcl/set-time-command","title":"set-time command","category":"TCL","categorySlug":"tcl","summary":"The set-time command sets the current system time. The hours are specified from 00 (12:00 AM) to 23 (11:00 PM). The current time can be displayed by pressing CTRL+M or Enter at the TCL prompt, or by entering the TCL command time. If the time is actually changed, set-time logs an entry in the errors file.","url":"https://d3codex.com/tcl/set-time-command/","api":"https://d3codex.com/api/topics/tcl/set-time-command.json"},{"slug":"tcl/set-units-command","title":"set-units command","category":"TCL","categorySlug":"tcl","summary":"The set-units command designates that a numeric expression of 1 is equal to 1 unit.","url":"https://d3codex.com/tcl/set-units-command/","api":"https://d3codex.com/api/topics/tcl/set-units-command.json"},{"slug":"tcl/setpib0-command","title":"setpib0 command","category":"TCL","categorySlug":"tcl","summary":"The setpib0 command resets the system’s port 0 (console) to the correct terminal type. The default terminal type varies from platform to platform:","url":"https://d3codex.com/tcl/setpib0-command/","api":"https://d3codex.com/api/topics/tcl/setpib0-command.json"},{"slug":"tcl/setport-command","title":"setport command","category":"TCL","categorySlug":"tcl","summary":"The setport BASIC program sets all ports (except port 0) to 9600 baud, no parity, 1 stop bit, and 8 data bits.","url":"https://d3codex.com/tcl/setport-command/","api":"https://d3codex.com/api/topics/tcl/setport-command.json"},{"slug":"tcl/setup-printer-command","title":"setup-printer command","category":"TCL","categorySlug":"tcl","summary":"The setup-printer BASIC program downloads fonts to a laser printer attached to a form queue.","url":"https://d3codex.com/tcl/setup-printer-command/","api":"https://d3codex.com/api/topics/tcl/setup-printer-command.json"},{"slug":"tcl/shell-variable","title":"@ shell variable","category":"TCL","categorySlug":"tcl","summary":"The @ character indicates a D3 shell variable.","url":"https://d3codex.com/tcl/shell-variable/","api":"https://d3codex.com/api/topics/tcl/shell-variable.json"},{"slug":"tcl/shell-variable-off-macro","title":"shell-variable-off macro","category":"TCL","categorySlug":"tcl","summary":"The shell-variable-off macro disables shell variable replacement from TCL. This is the default setting.","url":"https://d3codex.com/tcl/shell-variable-off-macro/","api":"https://d3codex.com/api/topics/tcl/shell-variable-off-macro.json"},{"slug":"tcl/shell-variable-on-macro","title":"shell-variable-on macro","category":"TCL","categorySlug":"tcl","summary":"The shell-variable-on macro enables shell variable replacement from TCL.","url":"https://d3codex.com/tcl/shell-variable-on-macro/","api":"https://d3codex.com/api/topics/tcl/shell-variable-on-macro.json"},{"slug":"tcl/shp-kill-command","title":"shp-kill command","category":"TCL","categorySlug":"tcl","summary":"The shp-kill command terminates a D3 printer shared with UNIX and all the associated processes. Users who do not own the process and are not root, will not be able to kill the printer.","url":"https://d3codex.com/tcl/shp-kill-command/","api":"https://d3codex.com/api/topics/tcl/shp-kill-command.json"},{"slug":"tcl/shp-status-command","title":"shp-status command","category":"TCL","categorySlug":"tcl","summary":"The shp-status command displays status information about printers shared with UNIX, started by the startshp command.","url":"https://d3codex.com/tcl/shp-status-command/","api":"https://d3codex.com/api/topics/tcl/shp-status-command.json"},{"slug":"tcl/shpstat-command","title":"shpstat command","category":"TCL","categorySlug":"tcl","summary":"The shpstat BASIC program examines or changes the status of shared BASIC programs that have been compiled with FlashBASIC.","url":"https://d3codex.com/tcl/shpstat-command/","api":"https://d3codex.com/api/topics/tcl/shpstat-command.json"},{"slug":"tcl/shutdown-command","title":"shutdown command","category":"TCL","categorySlug":"tcl","summary":"The shutdown BASIC program initiates an orderly system shutdown sequence, and should be executed before turning off or rebooting any D3 system.","url":"https://d3codex.com/tcl/shutdown-command/","api":"https://d3codex.com/api/topics/tcl/shutdown-command.json"},{"slug":"tcl/sleep-command","title":"sleep command","category":"TCL","categorySlug":"tcl","summary":"The sleep command suspends further processing until the specified time expression is exhausted or reached.","url":"https://d3codex.com/tcl/sleep-command/","api":"https://d3codex.com/api/topics/tcl/sleep-command.json"},{"slug":"tcl/sort-list-command","title":"sort-list command","category":"TCL","categorySlug":"tcl","summary":"The sort-list BASIC program retrieves a previously saved list, sorts it, then rewrites it to the file from which it was retrieved.","url":"https://d3codex.com/tcl/sort-list-command/","api":"https://d3codex.com/api/topics/tcl/sort-list-command.json"},{"slug":"tcl/sort-users-command","title":"sort-users command","category":"TCL","categorySlug":"tcl","summary":"The sort-users BASIC program invokes the list-users BASIC program but sorts the output by user rather than by port number.","url":"https://d3codex.com/tcl/sort-users-command/","api":"https://d3codex.com/api/topics/tcl/sort-users-command.json"},{"slug":"tcl/sortc-command","title":"sortc command","category":"TCL","categorySlug":"tcl","summary":"The sortc BASIC program invokes the sort-label command to produce a columnar display of the item-IDs in the specified file, in the order of appearance in the file.","url":"https://d3codex.com/tcl/sortc-command/","api":"https://d3codex.com/api/topics/tcl/sortc-command.json"},{"slug":"tcl/sp-assign-command","title":"sp-assign command","category":"TCL","categorySlug":"tcl","summary":"The sp-assign command displays, changes, or resets the current spooler output assignment options for the current process/user. An sp-assign command with no options closes any currently open files assigned by the current process and resets the assignment to the default state. The default assignment is: output to printer, normal spooler entry (meaning, not a hold file), one copy, form queue 0, close files at end of process, queue job for output immediately upon closing.","url":"https://d3codex.com/tcl/sp-assign-command/","api":"https://d3codex.com/api/topics/tcl/sp-assign-command.json"},{"slug":"tcl/sp-close-command","title":"sp-close command","category":"TCL","categorySlug":"tcl","summary":"The sp-close command closes all current spooler entries previously opened by the current line with an sp-open command or an o option in conjunction with an sp-assign command.","url":"https://d3codex.com/tcl/sp-close-command/","api":"https://d3codex.com/api/topics/tcl/sp-close-command.json"},{"slug":"tcl/sp-edit-command","title":"sp-edit command","category":"TCL","categorySlug":"tcl","summary":"The sp-edit command accesses existing spooler entries for processing or deletion.","url":"https://d3codex.com/tcl/sp-edit-command/","api":"https://d3codex.com/api/topics/tcl/sp-edit-command.json"},{"slug":"tcl/sp-kill-command","title":"sp-kill command","category":"TCL","categorySlug":"tcl","summary":"The sp-kill command stops spooler entry output or removes printers and shared printers.","url":"https://d3codex.com/tcl/sp-kill-command/","api":"https://d3codex.com/api/topics/tcl/sp-kill-command.json"},{"slug":"tcl/sp-open-command","title":"sp-open command","category":"TCL","categorySlug":"tcl","summary":"The sp-open command leaves the next spooler entry generated by the current process open upon completion of the output generating process. Any subsequent (printer) output is attached to the end of the open entry, until an sp-close command or an sp-assign command is issued.","url":"https://d3codex.com/tcl/sp-open-command/","api":"https://d3codex.com/api/topics/tcl/sp-open-command.json"},{"slug":"tcl/sp-status-command","title":"sp-status command","category":"TCL","categorySlug":"tcl","summary":"The sp-status command displays the status of all spooler-controlled devices.","url":"https://d3codex.com/tcl/sp-status-command/","api":"https://d3codex.com/api/topics/tcl/sp-status-command.json"},{"slug":"tcl/sp-tapeout-command","title":"sp-tapeout command","category":"TCL","categorySlug":"tcl","summary":"The sp-tapeout command retrieves (inputs) reports previously spooled to magnetic media and directs output to the spooler. The spooler redirects the file according to the options currently specified in sp-assign.","url":"https://d3codex.com/tcl/sp-tapeout-command/","api":"https://d3codex.com/api/topics/tcl/sp-tapeout-command.json"},{"slug":"tcl/speller-command","title":"speller command","category":"TCL","categorySlug":"tcl","summary":"The speller command enables or disables the spelling checker for the current user/port only, or displays the status of the speller if no options are provided.","url":"https://d3codex.com/tcl/speller-command/","api":"https://d3codex.com/api/topics/tcl/speller-command.json"},{"slug":"tcl/spooler-account","title":"Spooler account","category":"TCL","categorySlug":"tcl","summary":"The spooler account holds a file called peqs that is used to reference spooler jobs as normal D3 items and can be listed, sorted, and selected in any sequence.","url":"https://d3codex.com/tcl/spooler-account/","api":"https://d3codex.com/api/topics/tcl/spooler-account.json"},{"slug":"tcl/spooler-overview","title":"Spooler overview","category":"TCL","categorySlug":"tcl","summary":"The spooler controls all output that is sent to a printer. Spooler is an acronym derived from simultaneous peripheral output online.","url":"https://d3codex.com/tcl/spooler-overview/","api":"https://d3codex.com/api/topics/tcl/spooler-overview.json"},{"slug":"tcl/ssample-command","title":"ssample command","category":"TCL","categorySlug":"tcl","summary":"The ssample command creates and sorts a temporary select-list of the first n items in a file that match the specified criteria. This command is useful when testing a small number of items. For example, testing 100 items in a file rather than processing all 10,000 items.","url":"https://d3codex.com/tcl/ssample-command/","api":"https://d3codex.com/api/topics/tcl/ssample-command.json"},{"slug":"tcl/stack-command","title":"stack command","category":"TCL","categorySlug":"tcl","summary":"The stack command enables or disables the tcl-stacking function for the current port only, or displays the status of the stacker if no options are provided.","url":"https://d3codex.com/tcl/stack-command/","api":"https://d3codex.com/api/topics/tcl/stack-command.json"},{"slug":"tcl/start-reclaim-ovf-command","title":"start-reclaim-ovf command","category":"TCL","categorySlug":"tcl","summary":"The start-reclaim-ovf BASIC program’s overflow reclamation process is initiated on the current line or as a phantom process if the b option was specified with the reclaim-ovf command.","url":"https://d3codex.com/tcl/start-reclaim-ovf-command/","api":"https://d3codex.com/api/topics/tcl/start-reclaim-ovf-command.json"},{"slug":"tcl/start-rtc-command","title":"start.rtc command","category":"TCL","categorySlug":"tcl","summary":"The start.rtc BASIC program initiates the system’s real-time clock. This happens automatically during the boot process, provided a real-time clock is present. If one is not present, the current time is requested from the person standing closest to the console.","url":"https://d3codex.com/tcl/start-rtc-command/","api":"https://d3codex.com/api/topics/tcl/start-rtc-command.json"},{"slug":"tcl/start-ss-command","title":"start.ss command","category":"TCL","categorySlug":"tcl","summary":"The start.ss command starts the spooler and the phantom scheduler.","url":"https://d3codex.com/tcl/start-ss-command/","api":"https://d3codex.com/api/topics/tcl/start-ss-command.json"},{"slug":"tcl/startlog-command","title":"startlog command","category":"TCL","categorySlug":"tcl","summary":"The startlog command activates the transaction logging subsystem. All items in files with a dl-type are automatically logged to the attached magnetic media on each add, change, or delete to the item.","url":"https://d3codex.com/tcl/startlog-command/","api":"https://d3codex.com/api/topics/tcl/startlog-command.json"},{"slug":"tcl/startptr-command","title":"startptr command","category":"TCL","categorySlug":"tcl","summary":"The startptr command activates and initializes up to 2048 printers. The actual number of printers supported depends on the hardware configuration. If the status of the printer is active, startptr has no effect.","url":"https://d3codex.com/tcl/startptr-command/","api":"https://d3codex.com/api/topics/tcl/startptr-command.json"},{"slug":"tcl/startshp-command","title":"startshp command","category":"TCL","categorySlug":"tcl","summary":"The startshp command starts a shared printer under UNIX. The output of the D3 printer process is routed to the UNIX spooler. This command combines the startptr command and the necessary assignfq command.","url":"https://d3codex.com/tcl/startshp-command/","api":"https://d3codex.com/api/topics/tcl/startshp-command.json"},{"slug":"tcl/startspooler-command","title":"startspooler command","category":"TCL","categorySlug":"tcl","summary":"The startspooler command kills all printers associated with the spooler, then initializes the spooler and returns it to normal operation. This process is usually invoked when the system is powered on.","url":"https://d3codex.com/tcl/startspooler-command/","api":"https://d3codex.com/api/topics/tcl/startspooler-command.json"},{"slug":"tcl/steal-file-command","title":"steal-file command","category":"TCL","categorySlug":"tcl","summary":"The steal-file BASIC program is the only valid way to move a file from another account into the current account.","url":"https://d3codex.com/tcl/steal-file-command/","api":"https://d3codex.com/api/topics/tcl/steal-file-command.json"},{"slug":"tcl/stoplog-command","title":"stoplog command","category":"TCL","categorySlug":"tcl","summary":"The stoplog command stops the transaction logger and detaches the transaction logger tape.","url":"https://d3codex.com/tcl/stoplog-command/","api":"https://d3codex.com/api/topics/tcl/stoplog-command.json"},{"slug":"tcl/stopptr-command","title":"stopptr command","category":"TCL","categorySlug":"tcl","summary":"The stopptr command stops the specified printer at the end of the current print job. If the printer is inactive, it stops immediately. If it is active, it stops at the end of the current print file. If the current print file is specified to print multiple copies, the printer stops after the completion of the current copy. Sys2 privileges are required to use stopptr. Executing this command without specifying a printer attempts to stop printer 0.","url":"https://d3codex.com/tcl/stopptr-command/","api":"https://d3codex.com/api/topics/tcl/stopptr-command.json"},{"slug":"tcl/stopsched-command","title":"stopsched command","category":"TCL","categorySlug":"tcl","summary":"The stopsched command halts the phantom scheduler process. No phantom processing can occur if the phantom scheduler is deactivated.","url":"https://d3codex.com/tcl/stopsched-command/","api":"https://d3codex.com/api/topics/tcl/stopsched-command.json"},{"slug":"tcl/sub-command","title":"sub command","category":"TCL","categorySlug":"tcl","summary":"The sub command subtracts the second integer number provided from the first integer number provided and displays the result as an integer number.","url":"https://d3codex.com/tcl/sub-command/","api":"https://d3codex.com/api/topics/tcl/sub-command.json"},{"slug":"tcl/subx-command","title":"subx command","category":"TCL","categorySlug":"tcl","summary":"The subx command subtracts the second hexadecimal number provided from the first hexadecimal number provided and displays the result as a hexadecimal number.","url":"https://d3codex.com/tcl/subx-command/","api":"https://d3codex.com/api/topics/tcl/subx-command.json"},{"slug":"tcl/syschk-command","title":"syschk command","category":"TCL","categorySlug":"tcl","summary":"The syschk BASIC program checks a system running under UNIX to detect abnormal situations.","url":"https://d3codex.com/tcl/syschk-command/","api":"https://d3codex.com/api/topics/tcl/syschk-command.json"},{"slug":"tcl/sysid-command","title":"sysid command","category":"TCL","categorySlug":"tcl","summary":"The sysid BASIC program displays system configuration, options, and features.","url":"https://d3codex.com/tcl/sysid-command/","api":"https://d3codex.com/api/topics/tcl/sysid-command.json"},{"slug":"tcl/system-coldstart-macro","title":"system-coldstart macro","category":"TCL","categorySlug":"tcl","summary":"The system-coldstart macro executes system initialization commands.","url":"https://d3codex.com/tcl/system-coldstart-macro/","api":"https://d3codex.com/api/topics/tcl/system-coldstart-macro.json"},{"slug":"tcl/t-act-command","title":"t-act command","category":"TCL","categorySlug":"tcl","summary":"The t-act command selects a previously attached tape device as the currently active device to read and write to. D3 releases not only can have many users using many tapes simultaneously, a single user can have multiple tapes. This command allows switching between tapes.","url":"https://d3codex.com/tcl/t-act-command/","api":"https://d3codex.com/api/topics/tcl/t-act-command.json"},{"slug":"tcl/t-att-command","title":"t-att command","category":"TCL","categorySlug":"tcl","summary":"The t-att command attaches the tape unit or floppy disk drive to the current process unit and optionally assigns the block size to the tape I/O buffer.","url":"https://d3codex.com/tcl/t-att-command/","api":"https://d3codex.com/api/topics/tcl/t-att-command.json"},{"slug":"tcl/t-bck-command","title":"t-bck command","category":"TCL","categorySlug":"tcl","summary":"The t-bck command backspaces the tape to the end of the previous file or a specified number of blocks.","url":"https://d3codex.com/tcl/t-bck-command/","api":"https://d3codex.com/api/topics/tcl/t-bck-command.json"},{"slug":"tcl/t-bsf-command","title":"t-bsf command","category":"TCL","categorySlug":"tcl","summary":"The t-bsf command backspaces a given number of files.","url":"https://d3codex.com/tcl/t-bsf-command/","api":"https://d3codex.com/api/topics/tcl/t-bsf-command.json"},{"slug":"tcl/t-bsr-command","title":"t-bsr command","category":"TCL","categorySlug":"tcl","summary":"The t-bsr command backspaces a given number of records.","url":"https://d3codex.com/tcl/t-bsr-command/","api":"https://d3codex.com/api/topics/tcl/t-bsr-command.json"},{"slug":"tcl/t-cascade-command","title":"t-cascade command","category":"TCL","categorySlug":"tcl","summary":"The t-cascade command cascades or links one tape device to another tape device, either in a chain or a loop. Instead of prompting for the next reel, the system uses the forwardly linked device specified. Tape attachment is not checked. This command updates the links of the tape devices.","url":"https://d3codex.com/tcl/t-cascade-command/","api":"https://d3codex.com/api/topics/tcl/t-cascade-command.json"},{"slug":"tcl/t-chk-command","title":"t-chk command","category":"TCL","categorySlug":"tcl","summary":"The t-chk command checks a tape for parity errors. At the end of the process, the number of files checked displays.","url":"https://d3codex.com/tcl/t-chk-command/","api":"https://d3codex.com/api/topics/tcl/t-chk-command.json"},{"slug":"tcl/t-copy-command","title":"t-copy command","category":"TCL","categorySlug":"tcl","summary":"The t-copy BASIC program copies data from one device to another.","url":"https://d3codex.com/tcl/t-copy-command/","api":"https://d3codex.com/api/topics/tcl/t-copy-command.json"},{"slug":"tcl/t-det-command","title":"t-det command","category":"TCL","categorySlug":"tcl","summary":"The t-det command detaches the tape from the current process or from another process. If no device number is specified, then all tape devices currently attached to this process are detached.","url":"https://d3codex.com/tcl/t-det-command/","api":"https://d3codex.com/api/topics/tcl/t-det-command.json"},{"slug":"tcl/t-dump-command","title":"t-dump command","category":"TCL","categorySlug":"tcl","summary":"The t-dump command copies items from a given file to the attached peripheral storage device. The heading modifier allows specifying the contents of the tape label written to the tape prior to the dump. The tape must already be at load point in order to write the tape label.","url":"https://d3codex.com/tcl/t-dump-command/","api":"https://d3codex.com/api/topics/tcl/t-dump-command.json"},{"slug":"tcl/t-eod-command","title":"t-eod command","category":"TCL","categorySlug":"tcl","summary":"The t-eod command moves a tape forward to the end of the recorded data.","url":"https://d3codex.com/tcl/t-eod-command/","api":"https://d3codex.com/api/topics/tcl/t-eod-command.json"},{"slug":"tcl/t-fsf-command","title":"t-fsf command","category":"TCL","categorySlug":"tcl","summary":"The t-fsf (forward space file) command forwards a tape a given number of files. If the number is omitted, this command behaves like a t-fwd command.","url":"https://d3codex.com/tcl/t-fsf-command/","api":"https://d3codex.com/api/topics/tcl/t-fsf-command.json"},{"slug":"tcl/t-fsr-command","title":"t-fsr command","category":"TCL","categorySlug":"tcl","summary":"The t-fsr (forward space record) command forwards a tape a given number of records. If the number is omitted, this command behaves like a t-fwd command.","url":"https://d3codex.com/tcl/t-fsr-command/","api":"https://d3codex.com/api/topics/tcl/t-fsr-command.json"},{"slug":"tcl/t-fwd-command","title":"t-fwd command","category":"TCL","categorySlug":"tcl","summary":"The t-fwd command moves the attached media forward to the next file, or moves the tape forward a specified number of blocks. The t-fwd command stops automatically at an EOF.","url":"https://d3codex.com/tcl/t-fwd-command/","api":"https://d3codex.com/api/topics/tcl/t-fwd-command.json"},{"slug":"tcl/t-link-command","title":"t-link command","category":"TCL","categorySlug":"tcl","summary":"The t-link command links or cascades one tape device to another tape device, either in a chain or a loop. Instead of prompting for the next reel, the system uses the forwardly linked device specified. Tape attachment is not checked. This command updates the links of the tape devices.","url":"https://d3codex.com/tcl/t-link-command/","api":"https://d3codex.com/api/topics/tcl/t-link-command.json"},{"slug":"tcl/t-load-command","title":"t-load command","category":"TCL","categorySlug":"tcl","summary":"The t-load command restores files from a tape that was generated by t-dump. If a selection criteria is not specified, the entire file is loaded. If multiple t-dump commands were performed, then multiple executions of t-load are required to restore the data.","url":"https://d3codex.com/tcl/t-load-command/","api":"https://d3codex.com/api/topics/tcl/t-load-command.json"},{"slug":"tcl/t-rdlbl-command","title":"t-rdlbl command","category":"TCL","categorySlug":"tcl","summary":"The t-rdlbl command reads the label from the attached magnetic media and initializes the internal label storage area.","url":"https://d3codex.com/tcl/t-rdlbl-command/","api":"https://d3codex.com/api/topics/tcl/t-rdlbl-command.json"},{"slug":"tcl/t-read-command","title":"t-read command","category":"TCL","categorySlug":"tcl","summary":"The t-read command reads from the magnetic media unit attached to the current process and displays the contents of each block read to the terminal or printer. Any type of Pick-formatted media may be read with this command.","url":"https://d3codex.com/tcl/t-read-command/","api":"https://d3codex.com/api/topics/tcl/t-read-command.json"},{"slug":"tcl/t-rew-command","title":"t-rew command","category":"TCL","categorySlug":"tcl","summary":"The t-rew command rewinds the attached media to the beginning of, or load point on, the tape.","url":"https://d3codex.com/tcl/t-rew-command/","api":"https://d3codex.com/api/topics/tcl/t-rew-command.json"},{"slug":"tcl/t-select-command","title":"t-select command","category":"TCL","categorySlug":"tcl","summary":"The t-select command attaches a tape device to the current process, but we recommend using the set-device TCL command.","url":"https://d3codex.com/tcl/t-select-command/","api":"https://d3codex.com/api/topics/tcl/t-select-command.json"},{"slug":"tcl/t-space-command","title":"t-space command","category":"TCL","categorySlug":"tcl","summary":"The t-space command moves the attached media forward a specified number of files, displaying each tape label as it is encountered.","url":"https://d3codex.com/tcl/t-space-command/","api":"https://d3codex.com/api/topics/tcl/t-space-command.json"},{"slug":"tcl/t-stat-command","title":"t-stat command","category":"TCL","categorySlug":"tcl","summary":"The t-stat command displays a report of the current attachment status for all tape devices defined on the system. It shows the device number and description, UNIX process name, density, and currently attached user.","url":"https://d3codex.com/tcl/t-stat-command/","api":"https://d3codex.com/api/topics/tcl/t-stat-command.json"},{"slug":"tcl/t-unload-command","title":"t-unload command","category":"TCL","categorySlug":"tcl","summary":"The t-unload command rewinds the attached tape. On D3 UNIX systems, this command does the usual tape unload. Depending on the UNIX operating system, this command may wait for the tape to rewind before returning.","url":"https://d3codex.com/tcl/t-unload-command/","api":"https://d3codex.com/api/topics/tcl/t-unload-command.json"},{"slug":"tcl/t-verify-command","title":"t-verify command","category":"TCL","categorySlug":"tcl","summary":"The t-verify command validates the integrity of file-save or account-save backups. The process can compare the contents of the backup media with the corresponding data on disk, or check the media to ensure that it has the correct backup format.","url":"https://d3codex.com/tcl/t-verify-command/","api":"https://d3codex.com/api/topics/tcl/t-verify-command.json"},{"slug":"tcl/t-weof-command","title":"t-weof command","category":"TCL","categorySlug":"tcl","summary":"The t-weof command writes an EOF mark at the current position on the attached magnetic media. It also causes a flush of the last buffer written. This is important to ensure any partially filled buffer was written onto the tape.","url":"https://d3codex.com/tcl/t-weof-command/","api":"https://d3codex.com/api/topics/tcl/t-weof-command.json"},{"slug":"tcl/t-wtlbl-command","title":"t-wtlbl command","category":"TCL","categorySlug":"tcl","summary":"The t-wtlbl command writes a Pick-format (80-byte) tape label at the current position on the attached magnetic media.","url":"https://d3codex.com/tcl/t-wtlbl-command/","api":"https://d3codex.com/api/topics/tcl/t-wtlbl-command.json"},{"slug":"tcl/tabs-command","title":"tabs command","category":"TCL","categorySlug":"tcl","summary":"The tabs command displays tab stops previously set via the editor (ed or edit) process, or assigns new tab stop positions for input (i) or output (o).","url":"https://d3codex.com/tcl/tabs-command/","api":"https://d3codex.com/api/topics/tcl/tabs-command.json"},{"slug":"tcl/tail-command","title":"tail command","category":"TCL","categorySlug":"tcl","summary":"The tail command displays a specified number of trailing lines for each of the items in a specified item-list (that is, the bottom-most lines contained in an item).","url":"https://d3codex.com/tcl/tail-command/","api":"https://d3codex.com/api/topics/tcl/tail-command.json"},{"slug":"tcl/tandem-command","title":"tandem command","category":"TCL","categorySlug":"tcl","summary":"The tandem command BASIC program links the current port to another process. Any input or output to either screen affects both screens.","url":"https://d3codex.com/tcl/tandem-command/","api":"https://d3codex.com/api/topics/tcl/tandem-command.json"},{"slug":"tcl/tape-devices-overview","title":"Tape devices overview","category":"TCL","categorySlug":"tcl","summary":"Tape devices are storage medium for reading and writing tapes.","url":"https://d3codex.com/tcl/tape-devices-overview/","api":"https://d3codex.com/api/topics/tcl/tape-devices-overview.json"},{"slug":"tcl/tape-socket-command","title":"tape-socket command","category":"TCL","categorySlug":"tcl","summary":"The tape-socket BASIC program defines a tape system across a network.","url":"https://d3codex.com/tcl/tape-socket-command/","api":"https://d3codex.com/api/topics/tcl/tape-socket-command.json"},{"slug":"tcl/tcl-command","title":"tcl command","category":"TCL","categorySlug":"tcl","summary":"The tcl command suspends the process on the specified port, pushes a level on that port, and then executes the TCL command.","url":"https://d3codex.com/tcl/tcl-command/","api":"https://d3codex.com/api/topics/tcl/tcl-command.json"},{"slug":"tcl/tcl-command-categories","title":"TCL command categories","category":"TCL","categorySlug":"tcl","summary":"This topic provides a categorized listing of many of the TCL commands.","url":"https://d3codex.com/tcl/tcl-command-categories/","api":"https://d3codex.com/api/topics/tcl/tcl-command-categories.json"},{"slug":"tcl/tcl-commands","title":"TCL commands","category":"TCL","categorySlug":"tcl","summary":"TCL Commands, which operate exclusively on files and items, use a consistent form to specify the file and items:","url":"https://d3codex.com/tcl/tcl-commands/","api":"https://d3codex.com/api/topics/tcl/tcl-commands.json"},{"slug":"tcl/tcl-hdr-command","title":"tcl-hdr command","category":"TCL","categorySlug":"tcl","summary":"The tcl-hdr command enables or disables the display of TCL commands on all output directed to the spooler, or displays the current header status if no options are provided.","url":"https://d3codex.com/tcl/tcl-hdr-command/","api":"https://d3codex.com/api/topics/tcl/tcl-hdr-command.json"},{"slug":"tcl/tcl-overview","title":"TCL overview","category":"TCL","categorySlug":"tcl","summary":"Terminal Control Language (TCL) is the gateway to all D3 functionality. TCL is a system-level command language with system-defined or user-defined statements that can be executed individually or sequentially. System-defined statements are called TCL commands. User-defined statements are: macros, menus, and cataloged FlashBASIC programs.","url":"https://d3codex.com/tcl/tcl-overview/","api":"https://d3codex.com/api/topics/tcl/tcl-overview.json"},{"slug":"tcl/tcl-prompt-command","title":"tcl-prompt command","category":"TCL","categorySlug":"tcl","summary":"The tcl-prompt BASIC program sets the prefix to the TCL prompt.","url":"https://d3codex.com/tcl/tcl-prompt-command/","api":"https://d3codex.com/api/topics/tcl/tcl-prompt-command.json"},{"slug":"tcl/tcl-stack","title":"TCL stack","category":"TCL","categorySlug":"tcl","summary":"When a command is entered at the TCL prompt, the system saves the command in the TCL stack file of the dm account. Your stack is not terminal dependent. If you leave a terminal without logging off, another user can use the terminal under your user-ID. This causes the new user to step-on the stack.","url":"https://d3codex.com/tcl/tcl-stack/","api":"https://d3codex.com/api/topics/tcl/tcl-stack.json"},{"slug":"tcl/tcls-command","title":"tcls command","category":"TCL","categorySlug":"tcl","summary":"The tcls command suspends the process on the specified port, pushes a level on that port, then executes the TCL command. This is different from the tcl command in that tcls suppresses the messages generated by the command that was executed on the remote port.","url":"https://d3codex.com/tcl/tcls-command/","api":"https://d3codex.com/api/topics/tcl/tcls-command.json"},{"slug":"tcl/term-command","title":"term command","category":"TCL","categorySlug":"tcl","summary":"The term BASIC program changes or displays the current terminal and printer output characteristics for the current line.","url":"https://d3codex.com/tcl/term-command/","api":"https://d3codex.com/api/topics/tcl/term-command.json"},{"slug":"tcl/term-font-command","title":"term.font command","category":"TCL","categorySlug":"tcl","summary":"The term.font BASIC program downloads fonts to a Wyse 60 terminal. It uses a special file, which has 8x16 matrixes for every character in hexadecimal format.","url":"https://d3codex.com/tcl/term-font-command/","api":"https://d3codex.com/api/topics/tcl/term-font-command.json"},{"slug":"tcl/term-type-command","title":"term-type command","category":"TCL","categorySlug":"tcl","summary":"The term-type BASIC program reads the terminal and printer characteristics from attribute 2 of the PIBs file and automatically sets them, or sets them and updates the permanent settings for the current line.","url":"https://d3codex.com/tcl/term-type-command/","api":"https://d3codex.com/api/topics/tcl/term-type-command.json"},{"slug":"tcl/terminal-control-language","title":"Terminal control language","category":"TCL","categorySlug":"tcl","summary":"This section discusses the Terminal Control language (TCL).","url":"https://d3codex.com/tcl/terminal-control-language/","api":"https://d3codex.com/api/topics/tcl/terminal-control-language.json"},{"slug":"tcl/termp-command","title":"termp command","category":"TCL","categorySlug":"tcl","summary":"The termp BASIC program is an interactive form of the term command. It prompts for the terminal and printer characteristics for the line on which the command is invoked.","url":"https://d3codex.com/tcl/termp-command/","api":"https://d3codex.com/api/topics/tcl/termp-command.json"},{"slug":"tcl/termu-command","title":"termu command","category":"TCL","categorySlug":"tcl","summary":"The termu BASIC program automatically updates the term width and depth.","url":"https://d3codex.com/tcl/termu-command/","api":"https://d3codex.com/api/topics/tcl/termu-command.json"},{"slug":"tcl/time-command","title":"time command","category":"TCL","categorySlug":"tcl","summary":"The time BASIC program displays the system time and date. If no time parameter exists, the current time and date displays.","url":"https://d3codex.com/tcl/time-command/","api":"https://d3codex.com/api/topics/tcl/time-command.json"},{"slug":"tcl/timedate-command","title":"timedate command","category":"TCL","categorySlug":"tcl","summary":"The timedate command sets or displays the status of the time and date display.","url":"https://d3codex.com/tcl/timedate-command/","api":"https://d3codex.com/api/topics/tcl/timedate-command.json"},{"slug":"tcl/timeout-command","title":"timeout command","category":"TCL","categorySlug":"tcl","summary":"The timeout BASIC program sets the time (in seconds) to automatically log off due to inactivity.","url":"https://d3codex.com/tcl/timeout-command/","api":"https://d3codex.com/api/topics/tcl/timeout-command.json"},{"slug":"tcl/tlog-restore-command","title":"tlog-restore command","category":"TCL","categorySlug":"tcl","summary":"The tlog-restore command restores data from a transaction log magnetic media. This is an alternative to restoring at the end of a full restore or account restore from a ’save-class’ media.","url":"https://d3codex.com/tcl/tlog-restore-command/","api":"https://d3codex.com/api/topics/tcl/tlog-restore-command.json"},{"slug":"tcl/tlqdisplay-command","title":"tlqdisplay command","category":"TCL","categorySlug":"tcl","summary":"The tlqdisplay command allows you to display the transactions within the transaction queue used by both the D3 Transaction Logger and Hot Backup components. The start location in the transaction queue can be specified.","url":"https://d3codex.com/tcl/tlqdisplay-command/","api":"https://d3codex.com/api/topics/tcl/tlqdisplay-command.json"},{"slug":"tcl/touch-command","title":"touch command","category":"TCL","categorySlug":"tcl","summary":"The touch BASIC program reads and rewrites all items, without changing them, in either specified files or in all files in specified accounts.","url":"https://d3codex.com/tcl/touch-command/","api":"https://d3codex.com/api/topics/tcl/touch-command.json"},{"slug":"tcl/transaction-utility","title":"transaction utility","category":"TCL","categorySlug":"tcl","summary":"The transaction utility is the system administration utility for transaction processing.","url":"https://d3codex.com/tcl/transaction-utility/","api":"https://d3codex.com/api/topics/tcl/transaction-utility.json"},{"slug":"tcl/trap-command","title":"trap command","category":"TCL","categorySlug":"tcl","summary":"The trap BASIC program allows a TCL command (signal handler) to be executed when receiving a specific signal.","url":"https://d3codex.com/tcl/trap-command/","api":"https://d3codex.com/api/topics/tcl/trap-command.json"},{"slug":"tcl/truncate-ovf-command","title":"truncate-ovf command","category":"TCL","categorySlug":"tcl","summary":"The truncate-ovf command truncates the safe overflow table to 1 block from high-water to maxfid and kills the B-tree table.","url":"https://d3codex.com/tcl/truncate-ovf-command/","api":"https://d3codex.com/api/topics/tcl/truncate-ovf-command.json"},{"slug":"tcl/txlog-command","title":"txlog command","category":"TCL","categorySlug":"tcl","summary":"The txlog BASIC program invokes a menu for administration of the transaction logging subsystem.","url":"https://d3codex.com/tcl/txlog-command/","api":"https://d3codex.com/api/topics/tcl/txlog-command.json"},{"slug":"tcl/txlog-off-command","title":"txlog-off command","category":"TCL","categorySlug":"tcl","summary":"The txlog-off command turns off transaction log enqueueing for the current process. No matter what operation is done by the user, a transaction will not be placed in the queue for later dequeuing to the tape or hot backup machine.","url":"https://d3codex.com/tcl/txlog-off-command/","api":"https://d3codex.com/api/topics/tcl/txlog-off-command.json"},{"slug":"tcl/txlog-on-command","title":"txlog-on command","category":"TCL","categorySlug":"tcl","summary":"The txlog-on command turns on transaction log enqueueing for the current process.","url":"https://d3codex.com/tcl/txlog-on-command/","api":"https://d3codex.com/api/topics/tcl/txlog-on-command.json"},{"slug":"tcl/txlog-status-command","title":"txlog-status command","category":"TCL","categorySlug":"tcl","summary":"The txlog-status command retrieves the last status of the transaction logging subsystem.","url":"https://d3codex.com/tcl/txlog-status-command/","api":"https://d3codex.com/api/topics/tcl/txlog-status-command.json"},{"slug":"tcl/type-ahead-command","title":"type-ahead command","category":"TCL","categorySlug":"tcl","summary":"The type-ahead command enables or disables the type ahead feature for the current PIB or displays the current status if no options are provided.","url":"https://d3codex.com/tcl/type-ahead-command/","api":"https://d3codex.com/api/topics/tcl/type-ahead-command.json"},{"slug":"tcl/ud-command","title":"ud command","category":"TCL","categorySlug":"tcl","summary":"The ud BASIC program invokes the Update processor to edit ADIs or file-defining items in the dictionary of the specified file.","url":"https://d3codex.com/tcl/ud-command/","api":"https://d3codex.com/api/topics/tcl/ud-command.json"},{"slug":"tcl/udate-command","title":"udate command","category":"TCL","categorySlug":"tcl","summary":"The udate command sets the system date format to the United States standard.","url":"https://d3codex.com/tcl/udate-command/","api":"https://d3codex.com/api/topics/tcl/udate-command.json"},{"slug":"tcl/um-command","title":"um command","category":"TCL","categorySlug":"tcl","summary":"The um command displays the conversion units set by the set-units, set-dozens, set-decimal, or set-thousands commands.","url":"https://d3codex.com/tcl/um-command/","api":"https://d3codex.com/api/topics/tcl/um-command.json"},{"slug":"tcl/unix-command","title":"unix command","category":"TCL","categorySlug":"tcl","summary":"The unix command invokes the sh command, to push a shell, and then automatically returns to D3 on completion.","url":"https://d3codex.com/tcl/unix-command/","api":"https://d3codex.com/api/topics/tcl/unix-command.json"},{"slug":"tcl/unlink-pibdev-command","title":"unlink-pibdev command","category":"TCL","categorySlug":"tcl","summary":"The unlink-pibdev BASIC program unlinks a process from a port.","url":"https://d3codex.com/tcl/unlink-pibdev-command/","api":"https://d3codex.com/api/topics/tcl/unlink-pibdev-command.json"},{"slug":"tcl/unlock-file-command","title":"unlock-file command","category":"TCL","categorySlug":"tcl","summary":"The unlock-file command clears file locks which have not been cleared through normal system operation.","url":"https://d3codex.com/tcl/unlock-file-command/","api":"https://d3codex.com/api/topics/tcl/unlock-file-command.json"},{"slug":"tcl/unlock-frame-command","title":"unlock-frame command","category":"TCL","categorySlug":"tcl","summary":"The unlock-frame command clears the memory corelock previously core-locked with a lock-frame command.","url":"https://d3codex.com/tcl/unlock-frame-command/","api":"https://d3codex.com/api/topics/tcl/unlock-frame-command.json"},{"slug":"tcl/unlock-group-command","title":"unlock-group command","category":"TCL","categorySlug":"tcl","summary":"The unlock-group command in the DM account clears group locks.","url":"https://d3codex.com/tcl/unlock-group-command/","api":"https://d3codex.com/api/topics/tcl/unlock-group-command.json"},{"slug":"tcl/unlock-item-command","title":"unlock-item command","category":"TCL","categorySlug":"tcl","summary":"The unlock-item BASIC program clears item locks that have not cleared through usual system operation.","url":"https://d3codex.com/tcl/unlock-item-command/","api":"https://d3codex.com/api/topics/tcl/unlock-item-command.json"},{"slug":"tcl/unset-command","title":"unset command","category":"TCL","categorySlug":"tcl","summary":"The unset BASIC program deletes a D3 user shell variable.","url":"https://d3codex.com/tcl/unset-command/","api":"https://d3codex.com/api/topics/tcl/unset-command.json"},{"slug":"tcl/update-abs-stamp-command","title":"update-abs-stamp command","category":"TCL","categorySlug":"tcl","summary":"The update-abs-stamp command in the DM account is invoked by the abs.fid command. This command also produces the actual output.","url":"https://d3codex.com/tcl/update-abs-stamp-command/","api":"https://d3codex.com/api/topics/tcl/update-abs-stamp-command.json"},{"slug":"tcl/update-command","title":"update command","category":"TCL","categorySlug":"tcl","summary":"The update command invokes the Update processor for adding, changing, deleting, or cruising through data in a given file.","url":"https://d3codex.com/tcl/update-command/","api":"https://d3codex.com/api/topics/tcl/update-command.json"},{"slug":"tcl/update-logging-command","title":"update-logging command","category":"TCL","categorySlug":"tcl","summary":"The update-logging command toggles or displays the status of the transaction logger subsystem.","url":"https://d3codex.com/tcl/update-logging-command/","api":"https://d3codex.com/api/topics/tcl/update-logging-command.json"},{"slug":"tcl/update-md-command","title":"update-md command","category":"TCL","categorySlug":"tcl","summary":"The update-md BASIC program updates command definitions in a specified account master dictionary, or in a list of master dictionaries. Any conflicts found are logged in the clashes file, with a new data section added for each account.","url":"https://d3codex.com/tcl/update-md-command/","api":"https://d3codex.com/api/topics/tcl/update-md-command.json"},{"slug":"tcl/update-prot-command","title":"update-prot command","category":"TCL","categorySlug":"tcl","summary":"The update-prot command toggles or displays the status of the file update protection scheme. When enabled, this feature globally protects all item updates so that a power-off condition does not cause a file inconsistency.","url":"https://d3codex.com/tcl/update-prot-command/","api":"https://d3codex.com/api/topics/tcl/update-prot-command.json"},{"slug":"tcl/user-coldstart-command","title":"user.coldstart command","category":"TCL","categorySlug":"tcl","summary":"The user.coldstart command is invoked by the coldstart to call the user.coldstart routine.","url":"https://d3codex.com/tcl/user-coldstart-command/","api":"https://d3codex.com/api/topics/tcl/user-coldstart-command.json"},{"slug":"tcl/user-coldstart-macro","title":"user-coldstart macro","category":"TCL","categorySlug":"tcl","summary":"The user.coldstart macro performs the last step of the coldstart process and is the place where users can customize their own sequence of activities to perform each time the system is powered on or rebooted.","url":"https://d3codex.com/tcl/user-coldstart-macro/","api":"https://d3codex.com/api/topics/tcl/user-coldstart-macro.json"},{"slug":"tcl/user-shutdown-macro","title":"user-shutdown macro","category":"TCL","categorySlug":"tcl","summary":"The user-shutdown macro is called by the shutdown command as the first procedure in shutting down the machine.","url":"https://d3codex.com/tcl/user-shutdown-macro/","api":"https://d3codex.com/api/topics/tcl/user-shutdown-macro.json"},{"slug":"tcl/useralarm-command","title":"useralarm command","category":"TCL","categorySlug":"tcl","summary":"The useralarm BASIC program is an alarm handler used by the trap command when a task is scheduled to be executed at a given time. When the alarm goes off, it scans the item dm,alarm.file, username to find what to do next. This command is not normally executed at TCL.","url":"https://d3codex.com/tcl/useralarm-command/","api":"https://d3codex.com/api/topics/tcl/useralarm-command.json"},{"slug":"tcl/verify-index-command","title":"verify-index command","category":"TCL","categorySlug":"tcl","summary":"The verify-index BASIC program verifies the integrity of one or all B-tree indexes in a specified file name.","url":"https://d3codex.com/tcl/verify-index-command/","api":"https://d3codex.com/api/topics/tcl/verify-index-command.json"},{"slug":"tcl/verify-system-command","title":"verify-system command","category":"TCL","categorySlug":"tcl","summary":"The verify-system BASIC program verifies the integrity of the D3 system software by comparing computed checksums for the executable ABS frames with corresponding checksums stored in the data section of the file reference file.","url":"https://d3codex.com/tcl/verify-system-command/","api":"https://d3codex.com/api/topics/tcl/verify-system-command.json"},{"slug":"tcl/video-demo-command","title":"video.demo command","category":"TCL","categorySlug":"tcl","summary":"The video.demo BASIC program demonstrates video display functions.","url":"https://d3codex.com/tcl/video-demo-command/","api":"https://d3codex.com/api/topics/tcl/video-demo-command.json"},{"slug":"tcl/view-command","title":"view command","category":"TCL","categorySlug":"tcl","summary":"The view BASIC program displays a single item in a full screen window. This is useful when a user wants to display an item without editing it.","url":"https://d3codex.com/tcl/view-command/","api":"https://d3codex.com/api/topics/tcl/view-command.json"},{"slug":"tcl/watch-command","title":"watch command","category":"TCL","categorySlug":"tcl","summary":"The watch command executes and re-executes a TCL command continuously until the user cancels the execution by pressing a key. The output of the first page of the specified TCL command is displayed on the screen continuously.","url":"https://d3codex.com/tcl/watch-command/","api":"https://d3codex.com/api/topics/tcl/watch-command.json"},{"slug":"tcl/what-command","title":"what command","category":"TCL","categorySlug":"tcl","summary":"The what command displays the system configuration and the status of system locks, specified lines, spooler, and printers.","url":"https://d3codex.com/tcl/what-command/","api":"https://d3codex.com/api/topics/tcl/what-command.json"},{"slug":"tcl/where-command","title":"where command","category":"TCL","categorySlug":"tcl","summary":"The where command displays the current execution status of all processes currently logged on to system or for selected port numbers.","url":"https://d3codex.com/tcl/where-command/","api":"https://d3codex.com/api/topics/tcl/where-command.json"},{"slug":"tcl/wherebt-macro","title":"wherebt macro","category":"TCL","categorySlug":"tcl","summary":"The wherebt macro invokes the wheres command with the bt parameter.","url":"https://d3codex.com/tcl/wherebt-macro/","api":"https://d3codex.com/api/topics/tcl/wherebt-macro.json"},{"slug":"tcl/whered-macro","title":"whered macro","category":"TCL","categorySlug":"tcl","summary":"The whered macro invokes the wheres command with the db parameter.","url":"https://d3codex.com/tcl/whered-macro/","api":"https://d3codex.com/api/topics/tcl/whered-macro.json"},{"slug":"tcl/whereindx-macro","title":"whereindx macro","category":"TCL","categorySlug":"tcl","summary":"The whereindx macro invokes the wheres command with the indx parameter.","url":"https://d3codex.com/tcl/whereindx-macro/","api":"https://d3codex.com/api/topics/tcl/whereindx-macro.json"},{"slug":"tcl/wherelk-macro","title":"wherelk macro","category":"TCL","categorySlug":"tcl","summary":"The wherelk macro invokes the wheres command with the lk parameter.","url":"https://d3codex.com/tcl/wherelk-macro/","api":"https://d3codex.com/api/topics/tcl/wherelk-macro.json"},{"slug":"tcl/whereovf-macro","title":"whereovf macro","category":"TCL","categorySlug":"tcl","summary":"The whereovf macro invokes the wheres command with ovf parameter.","url":"https://d3codex.com/tcl/whereovf-macro/","api":"https://d3codex.com/api/topics/tcl/whereovf-macro.json"},{"slug":"tcl/wherepu-macro","title":"wherepu macro","category":"TCL","categorySlug":"tcl","summary":"The wherepu macro invokes the wheres command with the pu parameter.","url":"https://d3codex.com/tcl/wherepu-macro/","api":"https://d3codex.com/api/topics/tcl/wherepu-macro.json"},{"slug":"tcl/wheres-command","title":"wheres command","category":"TCL","categorySlug":"tcl","summary":"The wheres BASIC program performs a variety of functions depending on the options or parameters provided, and displays a more readable form of the where command, including the user-ID, the account name, and the last command entered.","url":"https://d3codex.com/tcl/wheres-command/","api":"https://d3codex.com/api/topics/tcl/wheres-command.json"},{"slug":"tcl/wheresp-macro","title":"wheresp macro","category":"TCL","categorySlug":"tcl","summary":"The wheresp macro invokes the wheres command with the sp parameter.","url":"https://d3codex.com/tcl/wheresp-macro/","api":"https://d3codex.com/api/topics/tcl/wheresp-macro.json"},{"slug":"tcl/wheret-macro","title":"wheret macro","category":"TCL","categorySlug":"tcl","summary":"The wheret macro invokes the wheres command with the tp parameter.","url":"https://d3codex.com/tcl/wheret-macro/","api":"https://d3codex.com/api/topics/tcl/wheret-macro.json"},{"slug":"tcl/which-command","title":"which command","category":"TCL","categorySlug":"tcl","summary":"The which BASIC program displays the implementation being used, the software serial number, the system ID number, the release level, and UNIX specific system information.","url":"https://d3codex.com/tcl/which-command/","api":"https://d3codex.com/api/topics/tcl/which-command.json"},{"slug":"tcl/which-line-command","title":"which-line command","category":"TCL","categorySlug":"tcl","summary":"The which-line command puts the current port number into the Proc primary input buffer. This was used by the old Proc-version of power-off, which has subsequently been replaced by a FlashBASIC program.","url":"https://d3codex.com/tcl/which-line-command/","api":"https://d3codex.com/api/topics/tcl/which-line-command.json"},{"slug":"tcl/who-command","title":"who command","category":"TCL","categorySlug":"tcl","summary":"The who command displays the port number, user-ID, and account name for the current port, a specified port, or all ports.","url":"https://d3codex.com/tcl/who-command/","api":"https://d3codex.com/api/topics/tcl/who-command.json"},{"slug":"tcl/who-info-command","title":"who-info command","category":"TCL","categorySlug":"tcl","summary":"The who-info command enables or disables who output at TCL.","url":"https://d3codex.com/tcl/who-info-command/","api":"https://d3codex.com/api/topics/tcl/who-info-command.json"},{"slug":"tcl/whobt-macro","title":"whobt macro","category":"TCL","categorySlug":"tcl","summary":"The whobt macro invokes the wheres command with the bt parameter.","url":"https://d3codex.com/tcl/whobt-macro/","api":"https://d3codex.com/api/topics/tcl/whobt-macro.json"},{"slug":"tcl/whod-macro","title":"whod macro","category":"TCL","categorySlug":"tcl","summary":"The whod command invokes the wheres command with the db parameter.","url":"https://d3codex.com/tcl/whod-macro/","api":"https://d3codex.com/api/topics/tcl/whod-macro.json"},{"slug":"tcl/whoindx-macro","title":"whoindx macro","category":"TCL","categorySlug":"tcl","summary":"The whoindx macro invokes the wheres command with the indx parameter.","url":"https://d3codex.com/tcl/whoindx-macro/","api":"https://d3codex.com/api/topics/tcl/whoindx-macro.json"},{"slug":"tcl/wholk-macro","title":"wholk macro","category":"TCL","categorySlug":"tcl","summary":"The wholk macro invokes the wheres command with the lk parameter.","url":"https://d3codex.com/tcl/wholk-macro/","api":"https://d3codex.com/api/topics/tcl/wholk-macro.json"},{"slug":"tcl/whopu-macro","title":"whopu macro","category":"TCL","categorySlug":"tcl","summary":"The whopu macro invokes the wheres command with the pu parameter.","url":"https://d3codex.com/tcl/whopu-macro/","api":"https://d3codex.com/api/topics/tcl/whopu-macro.json"},{"slug":"tcl/whosp-macro","title":"whosp macro","category":"TCL","categorySlug":"tcl","summary":"The whosp macro invokes the wheres command with the sp parameter.","url":"https://d3codex.com/tcl/whosp-macro/","api":"https://d3codex.com/api/topics/tcl/whosp-macro.json"},{"slug":"tcl/whot-macro","title":"whot macro","category":"TCL","categorySlug":"tcl","summary":"The whot command displays the wheres information with the tp parameter.","url":"https://d3codex.com/tcl/whot-macro/","api":"https://d3codex.com/api/topics/tcl/whot-macro.json"},{"slug":"tcl/whovf-macro","title":"whovf macro","category":"TCL","categorySlug":"tcl","summary":"The whovf macro invokes the wheres command with the ov parameter.","url":"https://d3codex.com/tcl/whovf-macro/","api":"https://d3codex.com/api/topics/tcl/whovf-macro.json"},{"slug":"tcl/wincopy-command","title":"wincopy command","category":"TCL","categorySlug":"tcl","summary":"The wincopy command is a modified version of the copy command that copies items between D3 and the Windows file system.","url":"https://d3codex.com/tcl/wincopy-command/","api":"https://d3codex.com/api/topics/tcl/wincopy-command.json"},{"slug":"tcl/wincopy-command-2","title":"wincopy command","category":"TCL","categorySlug":"tcl","summary":"The wincopy command is a modified version of the copy command that copies items between D3 and the Windows file system.","url":"https://d3codex.com/tcl/wincopy-command-2/","api":"https://d3codex.com/api/topics/tcl/wincopy-command-2.json"},{"slug":"tcl/windows-gdi-printing-typeface-managementt","title":"Windows GDI printing typeface management","category":"TCL","categorySlug":"tcl","summary":"The Sample.Windows.Printer item in the dm,devices, file is a printer device driver template that controls the behavior of the various @() functions associated with Windows GDI printing.","url":"https://d3codex.com/tcl/windows-gdi-printing-typeface-managementt/","api":"https://d3codex.com/api/topics/tcl/windows-gdi-printing-typeface-managementt.json"},{"slug":"tcl/windows-printer-interface","title":"Windows printer interface","category":"TCL","categorySlug":"tcl","summary":"The Windows printer interface uses the Windows GDI printer driver (wingdiprinter), which employs BASIC @() function codes to embed character sequences into the print data stream.","url":"https://d3codex.com/tcl/windows-printer-interface/","api":"https://d3codex.com/api/topics/tcl/windows-printer-interface.json"},{"slug":"tcl/wlist-command","title":"wlist command","category":"TCL","categorySlug":"tcl","summary":"The wlist BASIC program is a simulation of the list command that additionally exploits B-tree indexes.","url":"https://d3codex.com/tcl/wlist-command/","api":"https://d3codex.com/api/topics/tcl/wlist-command.json"},{"slug":"tcl/wselect-command","title":"wselect command","category":"TCL","categorySlug":"tcl","summary":"The wselect BASIC program is a simulation of the select command that additionally exploits B-tree indexes.","url":"https://d3codex.com/tcl/wselect-command/","api":"https://d3codex.com/api/topics/tcl/wselect-command.json"},{"slug":"tcl/wsort-command","title":"wsort command","category":"TCL","categorySlug":"tcl","summary":"The wsort BASIC program is a simulation of the sort command that additionally exploits B-tree indexes.","url":"https://d3codex.com/tcl/wsort-command/","api":"https://d3codex.com/api/topics/tcl/wsort-command.json"},{"slug":"tcl/wsselect-command","title":"wsselect command","category":"TCL","categorySlug":"tcl","summary":"The wsselect BASIC program is a simulation of the sselect command that additionally exploits B-tree indexes.","url":"https://d3codex.com/tcl/wsselect-command/","api":"https://d3codex.com/api/topics/tcl/wsselect-command.json"},{"slug":"tcl/xcs-command","title":"xcs command","category":"TCL","categorySlug":"tcl","summary":"The xcs BASIC program enables or disables the extended character set for the current port or a specific port, or displays the status when no options are provided.","url":"https://d3codex.com/tcl/xcs-command/","api":"https://d3codex.com/api/topics/tcl/xcs-command.json"},{"slug":"tcl/xcs-off-macro","title":"xcs-off macro","category":"TCL","categorySlug":"tcl","summary":"The xcs-off macro disables the extended character set function on a specified port, or the current port if omitted.","url":"https://d3codex.com/tcl/xcs-off-macro/","api":"https://d3codex.com/api/topics/tcl/xcs-off-macro.json"},{"slug":"tcl/xcs-on-macro","title":"xcs-on macro","category":"TCL","categorySlug":"tcl","summary":"The xcs-on macro enables the extended character set function on a specified port, or the current port if omitted.","url":"https://d3codex.com/tcl/xcs-on-macro/","api":"https://d3codex.com/api/topics/tcl/xcs-on-macro.json"},{"slug":"tcl/xonoff-command","title":"xonoff command","category":"TCL","categorySlug":"tcl","summary":"The xonoff BASIC program disables or enables x-on/x-off on a specified port, or the current port.","url":"https://d3codex.com/tcl/xonoff-command/","api":"https://d3codex.com/api/topics/tcl/xonoff-command.json"},{"slug":"tcl/xtd-command","title":"xtd command","category":"TCL","categorySlug":"tcl","summary":"The xtd command converts a given hexadecimal number into its equivalent decimal (integer) format.","url":"https://d3codex.com/tcl/xtd-command/","api":"https://d3codex.com/api/topics/tcl/xtd-command.json"},{"slug":"tcl/z-command","title":"z command","category":"TCL","categorySlug":"tcl","summary":"","url":"https://d3codex.com/tcl/z-command/","api":"https://d3codex.com/api/topics/tcl/z-command.json"},{"slug":"unix/ap-core-file","title":"ap.core file","category":"UNIX","categorySlug":"unix","summary":"The ap.core file is created automatically in the directory, /usr/tmp, when either a machine abort occurs (for example, bus errors, segmentation violations, and so on), or by requesting the monitor debugger d command.","url":"https://d3codex.com/unix/ap-core-file/","api":"https://d3codex.com/api/topics/unix/ap-core-file.json"},{"slug":"unix/ap-log-file","title":"ap.log file","category":"UNIX","categorySlug":"unix","summary":"The ap.log file logs all errors and major events occurring on a D3 monitor virtual machine.","url":"https://d3codex.com/unix/ap-log-file/","api":"https://d3codex.com/api/topics/unix/ap-log-file.json"},{"slug":"unix/apcrash-command","title":"apcrash command","category":"UNIX","categorySlug":"unix","summary":"The apcrash command runs under UNIX to examine D3 core dumps.","url":"https://d3codex.com/unix/apcrash-command/","api":"https://d3codex.com/api/topics/unix/apcrash-command.json"},{"slug":"unix/ba-command","title":"ba command","category":"UNIX","categorySlug":"unix","summary":"The ba command adds a breakpoint.","url":"https://d3codex.com/unix/ba-command/","api":"https://d3codex.com/api/topics/unix/ba-command.json"},{"slug":"unix/bd-command","title":"bd command","category":"UNIX","categorySlug":"unix","summary":"The bd command deletes the breakpoint.","url":"https://d3codex.com/unix/bd-command/","api":"https://d3codex.com/api/topics/unix/bd-command.json"},{"slug":"unix/bl-command","title":"bl command","category":"UNIX","categorySlug":"unix","summary":"The bl command lists the monitor breakpoints.","url":"https://d3codex.com/unix/bl-command/","api":"https://d3codex.com/api/topics/unix/bl-command.json"},{"slug":"unix/bo-command","title":"bo command","category":"UNIX","categorySlug":"unix","summary":"The bo command is the breakpoint offset. This command defines both the FID and the displacement, which are used in computing the effective address of a breakpoint in the ba command.","url":"https://d3codex.com/unix/bo-command/","api":"https://d3codex.com/api/topics/unix/bo-command.json"},{"slug":"unix/boot-error-codes","title":"Boot error codes","category":"UNIX","categorySlug":"unix","summary":"When boot errors occur, the message and error code below displays:","url":"https://d3codex.com/unix/boot-error-codes/","api":"https://d3codex.com/api/topics/unix/boot-error-codes.json"},{"slug":"unix/changing-data","title":"Changing data","category":"UNIX","categorySlug":"unix","summary":"When a window of data displays, it is followed by an equal sign. Pressing CTRL+N displays the next window (if available) and CTRL+P displays the previous one.","url":"https://d3codex.com/unix/changing-data/","api":"https://d3codex.com/api/topics/unix/changing-data.json"},{"slug":"unix/command-mode","title":"command mode","category":"UNIX","categorySlug":"unix","summary":"In command mode, keystrokes perform functions such as moving the cursor, searching for patterns, or quitting from the document. All commands are referenced from the current cursor position.","url":"https://d3codex.com/unix/command-mode/","api":"https://d3codex.com/api/topics/unix/command-mode.json"},{"slug":"unix/d-command","title":"d command","category":"UNIX","categorySlug":"unix","summary":"The d command dumps the D3 core memory to the UNIX file /usr/tmp/ap.core. The result of the dump can be examined with the apcrash command. The d command can be used after an incident to dump selected elements of the current D3 memory to investigate the problem.","url":"https://d3codex.com/unix/d-command/","api":"https://d3codex.com/api/topics/unix/d-command.json"},{"slug":"unix/d-questionmark-command","title":"d? command","category":"UNIX","categorySlug":"unix","summary":"The d? command displays or changes the default dump string.","url":"https://d3codex.com/unix/d-questionmark-command/","api":"https://d3codex.com/api/topics/unix/d-questionmark-command.json"},{"slug":"unix/d3-command","title":"d3 command","category":"UNIX","categorySlug":"unix","summary":"The d3 command starts the D3 virtual machine or a D3 user process.","url":"https://d3codex.com/unix/d3-command/","api":"https://d3codex.com/api/topics/unix/d3-command.json"},{"slug":"unix/d3-signal-system-call","title":"D3 signal system call","category":"UNIX","categorySlug":"unix","summary":"The D3 monitor provides a system call to inform the D3 Virtual Environment of an incoming signal. This c function is called by the default signal system handlers, but also can be called by an application signal handler.","url":"https://d3codex.com/unix/d3-signal-system-call/","api":"https://d3codex.com/api/topics/unix/d3-signal-system-call.json"},{"slug":"unix/d3-unix-debugger-commands","title":"D3 UNIX debugger commands","category":"UNIX","categorySlug":"unix","summary":"The debugger prompts for a command with a one character code followed by an exclamation point.","url":"https://d3codex.com/unix/d3-unix-debugger-commands/","api":"https://d3codex.com/api/topics/unix/d3-unix-debugger-commands.json"},{"slug":"unix/d3tcl-command-unix","title":"d3tcl command (UNIX)","category":"UNIX","categorySlug":"unix","summary":"The d3tcl command allows execution of the D3 TCL commands directly from a UNIX shell.","url":"https://d3codex.com/unix/d3tcl-command-unix/","api":"https://d3codex.com/api/topics/unix/d3tcl-command-unix.json"},{"slug":"unix/d3wslistener-command","title":"d3WSListener command","category":"UNIX","categorySlug":"unix","summary":"Support for connections from the D3 Workstation is enabled by using the d3WSListener command","url":"https://d3codex.com/unix/d3wslistener-command/","api":"https://d3codex.com/api/topics/unix/d3wslistener-command.json"},{"slug":"unix/dot-profile-command","title":".profile command","category":"UNIX","categorySlug":"unix","summary":"The .profile command is a UNIX script executed when a UNIX user logs on.","url":"https://d3codex.com/unix/dot-profile-command/","api":"https://d3codex.com/api/topics/unix/dot-profile-command.json"},{"slug":"unix/e-command","title":"e command","category":"UNIX","categorySlug":"unix","summary":"The e command toggles the debugger on or off. When off, prevents entry to the debugger by pressing BREAK. On line 0, the debugger is entered in some special cases even when the debugger is disabled.","url":"https://d3codex.com/unix/e-command/","api":"https://d3codex.com/api/topics/unix/e-command.json"},{"slug":"unix/entering-the-debugger-monitor-debugger","title":"Entering the Debugger (Monitor Debugger)","category":"UNIX","categorySlug":"unix","summary":"The debugger can be entered:","url":"https://d3codex.com/unix/entering-the-debugger-monitor-debugger/","api":"https://d3codex.com/api/topics/unix/entering-the-debugger-monitor-debugger.json"},{"slug":"unix/env-command","title":"env command","category":"UNIX","categorySlug":"unix","summary":"The env command displays the UNIX environment variables.","url":"https://d3codex.com/unix/env-command/","api":"https://d3codex.com/api/topics/unix/env-command.json"},{"slug":"unix/exclamation-shell-command","title":"!shell command","category":"UNIX","categorySlug":"unix","summary":"The !shell command submits a shell command.","url":"https://d3codex.com/unix/exclamation-shell-command/","api":"https://d3codex.com/api/topics/unix/exclamation-shell-command.json"},{"slug":"unix/f-command","title":"f command","category":"UNIX","categorySlug":"unix","summary":"The f command flushes memory. All frames modified in memory are written back to disk. If a disk error occurs, a minus sign displays.","url":"https://d3codex.com/unix/f-command/","api":"https://d3codex.com/api/topics/unix/f-command.json"},{"slug":"unix/g-command","title":"g command","category":"UNIX","categorySlug":"unix","summary":"The g command process resumes execution without any argument.","url":"https://d3codex.com/unix/g-command/","api":"https://d3codex.com/api/topics/unix/g-command.json"},{"slug":"unix/gl-command","title":"gl command","category":"UNIX","categorySlug":"unix","summary":"The gl command displays or removes group locks.","url":"https://d3codex.com/unix/gl-command/","api":"https://d3codex.com/api/topics/unix/gl-command.json"},{"slug":"unix/h-command","title":"h command","category":"UNIX","categorySlug":"unix","summary":"The h command displays internal information about the specified FID if it is in memory, message <NIM> displays, or FID is not in memory.","url":"https://d3codex.com/unix/h-command/","api":"https://d3codex.com/api/topics/unix/h-command.json"},{"slug":"unix/halt-error-codes","title":"Halt error codes","category":"UNIX","categorySlug":"unix","summary":"When halt errors occur, the message and error code below display:","url":"https://d3codex.com/unix/halt-error-codes/","api":"https://d3codex.com/api/topics/unix/halt-error-codes.json"},{"slug":"unix/hot-backup-system","title":"Hot backup system","category":"UNIX","categorySlug":"unix","summary":"The hot backup system utilizes two machines to maintain continuous database availability. In the event of a failure, operations automatically switch to the backup system, minimizing both downtime and data loss.","url":"https://d3codex.com/unix/hot-backup-system/","api":"https://d3codex.com/api/topics/unix/hot-backup-system.json"},{"slug":"unix/insert-mode","title":"insert mode","category":"UNIX","categorySlug":"unix","summary":"In insert mode, the keyboard behaves like a typewriter. Keystrokes display as screen text after typing any of these commands.","url":"https://d3codex.com/unix/insert-mode/","api":"https://d3codex.com/api/topics/unix/insert-mode.json"},{"slug":"unix/k-command","title":"k command","category":"UNIX","categorySlug":"unix","summary":"The k command terminates the process associated with the PIB pib or the flusher, if used with the F key, by sending a SIGTERM to it. If used with the W key, the k command waits up to 10 seconds for the process to terminate. If it does not terminate, a SIGKILL is sent to it.","url":"https://d3codex.com/unix/k-command/","api":"https://d3codex.com/api/topics/unix/k-command.json"},{"slug":"unix/l-command","title":"l command","category":"UNIX","categorySlug":"unix","summary":"The l command displays, in hexadecimal, the link fields of the frame FID.","url":"https://d3codex.com/unix/l-command/","api":"https://d3codex.com/api/topics/unix/l-command.json"},{"slug":"unix/lppick-command","title":"lppick command","category":"UNIX","categorySlug":"unix","summary":"The lppick command filters between the output of a D3 printer and the UNIX spooler to implement shared printers. This command is called automatically by the TCL startshp command.","url":"https://d3codex.com/unix/lppick-command/","api":"https://d3codex.com/api/topics/unix/lppick-command.json"},{"slug":"unix/m-command","title":"m command","category":"UNIX","categorySlug":"unix","summary":"The m command displays or changes the real memory and the specified window at the real address.","url":"https://d3codex.com/unix/m-command/","api":"https://d3codex.com/api/topics/unix/m-command.json"},{"slug":"unix/monitor-debugger","title":"Monitor debugger","category":"UNIX","categorySlug":"unix","summary":"Use this tool to recover from system failures or when the virtual debugger cannot access the system resources.","url":"https://d3codex.com/unix/monitor-debugger/","api":"https://d3codex.com/api/topics/unix/monitor-debugger.json"},{"slug":"unix/p-command","title":"p command","category":"UNIX","categorySlug":"unix","summary":"The p command displays and changes the PIB. This command also displays the window bytes in the PIB specified by the PIB (that is, the current PIB if the PIB is omitted), at the optional offset.","url":"https://d3codex.com/unix/p-command/","api":"https://d3codex.com/api/topics/unix/p-command.json"},{"slug":"unix/perrpt-command","title":"perrpt command","category":"UNIX","categorySlug":"unix","summary":"The perrpt command displays, clears, restarts or suppresses the D3 error log maintained on UNIX. The system automatically logs every boot, shut down, and incident or abnormal procedure related to a D3 virtual machine.","url":"https://d3codex.com/unix/perrpt-command/","api":"https://d3codex.com/api/topics/unix/perrpt-command.json"},{"slug":"unix/pick-command","title":"pick command","category":"UNIX","categorySlug":"unix","summary":"","url":"https://d3codex.com/unix/pick-command/","api":"https://d3codex.com/api/topics/unix/pick-command.json"},{"slug":"unix/pick0-file","title":"pick0 file","category":"UNIX","categorySlug":"unix","summary":"The pick0 file defines the parameters required for each D3 virtual machine on the system.","url":"https://d3codex.com/unix/pick0-file/","api":"https://d3codex.com/api/topics/unix/pick0-file.json"},{"slug":"unix/precautions","title":"Precautions","category":"UNIX","categorySlug":"unix","summary":"A process started with the -D option has some special privileges, which might lead to data destruction if used indiscriminately:","url":"https://d3codex.com/unix/precautions/","api":"https://d3codex.com/api/topics/unix/precautions.json"},{"slug":"unix/q-command","title":"q command","category":"UNIX","categorySlug":"unix","summary":"The q command quits the monitor debugger.","url":"https://d3codex.com/unix/q-command/","api":"https://d3codex.com/api/topics/unix/q-command.json"},{"slug":"unix/questionmark-command","title":"? command","category":"UNIX","categorySlug":"unix","summary":"The ? command displays help information. The UNIX file /usr/lib/pick/sdb.help displays using the pg command.","url":"https://d3codex.com/unix/questionmark-command/","api":"https://d3codex.com/api/topics/unix/questionmark-command.json"},{"slug":"unix/r-command","title":"r command","category":"UNIX","categorySlug":"unix","summary":"The r command displays data through the register.","url":"https://d3codex.com/unix/r-command/","api":"https://d3codex.com/api/topics/unix/r-command.json"},{"slug":"unix/referencing-data","title":"Referencing data","category":"UNIX","categorySlug":"unix","summary":"Data can be referenced from the monitor debugger either in the virtual space or in the real memory space.","url":"https://d3codex.com/unix/referencing-data/","api":"https://d3codex.com/api/topics/unix/referencing-data.json"},{"slug":"unix/s-command-lowercase","title":"s command","category":"UNIX","categorySlug":"unix","summary":"The s command displays or changes the semaphore status.","url":"https://d3codex.com/unix/s-command-lowercase/","api":"https://d3codex.com/api/topics/unix/s-command-lowercase.json"},{"slug":"unix/s-command-uppercase","title":"S command","category":"UNIX","categorySlug":"unix","summary":"The S command scans the buffer table bits and displays and/or clears them depending on the certain criteria.","url":"https://d3codex.com/unix/s-command-uppercase/","api":"https://d3codex.com/api/topics/unix/s-command-uppercase.json"},{"slug":"unix/signal-description","title":"Signal description","category":"UNIX","categorySlug":"unix","summary":"This table lists the signals currently used by D3.","url":"https://d3codex.com/unix/signal-description/","api":"https://d3codex.com/api/topics/unix/signal-description.json"},{"slug":"unix/signal-usage","title":"Signal usage","category":"UNIX","categorySlug":"unix","summary":"D3 uses only UNIX System V.3 signals, which are common to more recent UNIX versions. Those systems that are not UNIX System V.3 signals are left to their default signal handler (such as, SIG_IGN) as set by the system.","url":"https://d3codex.com/unix/signal-usage/","api":"https://d3codex.com/api/topics/unix/signal-usage.json"},{"slug":"unix/synchronizing-two-d3-processes","title":"Synchronizing two D3 processes","category":"UNIX","categorySlug":"unix","summary":"On most conventional D3 implementations, synchronizing two D3 processes is done either through polling for the existence of a file or, more preferably, by using a FlashBASIC lock instruction. On most implementations, however, the FlashBASIC lock instruction itself involves, internally, a polling, thus causing the waiting process to consume CPU resources. By using signals, it is possible to have a process waiting for a signal to occur (a Break, log off or a signal generated by another process, possibly a UNIX process or a D3 process from another D3 virtual machine) without any CPU consumption.","url":"https://d3codex.com/unix/synchronizing-two-d3-processes/","api":"https://d3codex.com/api/topics/unix/synchronizing-two-d3-processes.json"},{"slug":"unix/t-command","title":"t command","category":"UNIX","categorySlug":"unix","summary":"The t command sets and removes the monitor trace. A minus sign displays, acknowledging the removal.","url":"https://d3codex.com/unix/t-command/","api":"https://d3codex.com/api/topics/unix/t-command.json"},{"slug":"unix/unix","title":"D3 reference manual for UNIX environment","category":"UNIX","categorySlug":"unix","summary":"Lists D3 commands and functionalities for a UNIX environment, assuming knowledge of UNIX operating systems and the D3 database management system (DBMS).","url":"https://d3codex.com/unix/unix/","api":"https://d3codex.com/api/topics/unix/unix.json"},{"slug":"unix/unix-commands","title":"UNIX commands","category":"UNIX","categorySlug":"unix","summary":"The following UNIX commands are available.","url":"https://d3codex.com/unix/unix-commands/","api":"https://d3codex.com/api/topics/unix/unix-commands.json"},{"slug":"unix/unix-files","title":"UNIX files","category":"UNIX","categorySlug":"unix","summary":"The following UNIX files are presented.","url":"https://d3codex.com/unix/unix-files/","api":"https://d3codex.com/api/topics/unix/unix-files.json"},{"slug":"unix/unix-signals","title":"UNIX signals","category":"UNIX","categorySlug":"unix","summary":"This topic examines UNIX signals in relationship to the D3 virtual machine.","url":"https://d3codex.com/unix/unix-signals/","api":"https://d3codex.com/api/topics/unix/unix-signals.json"},{"slug":"unix/usage-hints","title":"Usage hints","category":"UNIX","categorySlug":"unix","summary":"Reference for troubleshooting deadlocks, and their identification using debugger.","url":"https://d3codex.com/unix/usage-hints/","api":"https://d3codex.com/api/topics/unix/usage-hints.json"},{"slug":"unix/v-command","title":"v command","category":"UNIX","categorySlug":"unix","summary":"The v command enters the Virtual Debugger with a specified code. If a code is not specified, enter the debugger as if pressing the BREAK key.","url":"https://d3codex.com/unix/v-command/","api":"https://d3codex.com/api/topics/unix/v-command.json"},{"slug":"unix/vi-quick-reference","title":"VI editor quick reference commands","category":"UNIX","categorySlug":"unix","summary":"This information is not Rocket’s D3 documentation. It is reprinted from UNIX vi Quick Reference as reference material only.","url":"https://d3codex.com/unix/vi-quick-reference/","api":"https://d3codex.com/api/topics/unix/vi-quick-reference.json"},{"slug":"unix/x-command","title":"x command","category":"UNIX","categorySlug":"unix","summary":"The x command displays hardware registers on the first line of the program counter, followed by a variable number of 32 bit registers.","url":"https://d3codex.com/unix/x-command/","api":"https://d3codex.com/api/topics/unix/x-command.json"},{"slug":"updateprocessor/cruising-and-zooming-commands","title":"Cruising and zooming commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"Most Update Processor commands work the same whether or not dictionary attributes are in control. Some commands function differently when certain conditions are met. These commands provide the functionality for browsing on indexes.","url":"https://d3codex.com/updateprocessor/cruising-and-zooming-commands/","api":"https://d3codex.com/api/topics/updateprocessor/cruising-and-zooming-commands.json"},{"slug":"updateprocessor/cursor-movement-commands","title":"Cursor movement commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"Cursor movement commands are used to position the cursor anywhere in an item without altering the text.","url":"https://d3codex.com/updateprocessor/cursor-movement-commands/","api":"https://d3codex.com/api/topics/updateprocessor/cursor-movement-commands.json"},{"slug":"updateprocessor/filing-and-exiting-commands","title":"Filing and exiting commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"The CTRL+X commands offer different methods for exiting an item. CTRL+X signals to exit this item and perform one of a series of options. For example, an item can be exited and the information filed (saved), or the item can be exited without the information being filed.","url":"https://d3codex.com/updateprocessor/filing-and-exiting-commands/","api":"https://d3codex.com/api/topics/updateprocessor/filing-and-exiting-commands.json"},{"slug":"updateprocessor/hot-key-commands","title":"Hot key commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"Hot keys allow calling FlashBASIC subroutines from dictionaries using the Update processor command CTRL+Xnumber (the value of number is between 0 and 9).","url":"https://d3codex.com/updateprocessor/hot-key-commands/","api":"https://d3codex.com/api/topics/updateprocessor/hot-key-commands.json"},{"slug":"updateprocessor/macro-attribute","title":"macro attribute","category":"Update Processor","categorySlug":"updateprocessor","summary":"The macro attribute identifies the default attribute-defining items used for input and output processing of the item.","url":"https://d3codex.com/updateprocessor/macro-attribute/","api":"https://d3codex.com/api/topics/updateprocessor/macro-attribute.json"},{"slug":"updateprocessor/overtype-and-insert-commands","title":"Overtype and insert commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"When the Update processor is first entered, it is in overtype mode. This means any characters typed overwrite the characters on the screen. Insert mode is used to insert new text just in front of the text beginning at the cursor. When text is typed in the insert mode, the entered text is opened and shown on the next line until insert mode is exited or a cursor movement command is typed.","url":"https://d3codex.com/updateprocessor/overtype-and-insert-commands/","api":"https://d3codex.com/api/topics/updateprocessor/overtype-and-insert-commands.json"},{"slug":"updateprocessor/prestore-commands","title":"Prestore commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"Prestore commands are a series of Update processor commands that can be saved and recalled for later use. Once defined and saved, prestore commands can be used during the current update session or recalled and used in subsequent update sessions.","url":"https://d3codex.com/updateprocessor/prestore-commands/","api":"https://d3codex.com/api/topics/updateprocessor/prestore-commands.json"},{"slug":"updateprocessor/processing-codes-update-processor","title":"Processing codes (Update processor)","category":"Update Processor","categorySlug":"updateprocessor","summary":"Processing codes describe database links and data manipulation rules.","url":"https://d3codex.com/updateprocessor/processing-codes-update-processor/","api":"https://d3codex.com/api/topics/updateprocessor/processing-codes-update-processor.json"},{"slug":"updateprocessor/screen-display-commands","title":"Screen display commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"Screen display commands are used to redisplay the screen in various configurations.","url":"https://d3codex.com/updateprocessor/screen-display-commands/","api":"https://d3codex.com/api/topics/updateprocessor/screen-display-commands.json"},{"slug":"updateprocessor/spell-checking-commands","title":"Spell checking commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"The Update processor spelling checker verifies the spelling of text as it is entered. As each character is typed, the spelling checker verifies that the character or string of characters make or may become a legal word. The spelling checker beeps to indicate the word was not found, but does not interrupt the entry process.","url":"https://d3codex.com/updateprocessor/spell-checking-commands/","api":"https://d3codex.com/api/topics/updateprocessor/spell-checking-commands.json"},{"slug":"updateprocessor/text-editing-and-searching-commands","title":"Text editing and searching commands","category":"Update Processor","categorySlug":"updateprocessor","summary":"The commands below can be used to insert paragraphs, spaces, tab stops and values.","url":"https://d3codex.com/updateprocessor/text-editing-and-searching-commands/","api":"https://d3codex.com/api/topics/updateprocessor/text-editing-and-searching-commands.json"},{"slug":"updateprocessor/update-processor","title":"Update processor","category":"Update Processor","categorySlug":"updateprocessor","summary":"This section discusses the Update processor.","url":"https://d3codex.com/updateprocessor/update-processor/","api":"https://d3codex.com/api/topics/updateprocessor/update-processor.json"},{"slug":"updateprocessor/update-processor-overview","title":"Update processor overview","category":"Update Processor","categorySlug":"updateprocessor","summary":"The Update processor (UP) is a dictionary-driven, full-screen editor and data processor. Used with the Output processor, it operates as a document processor.","url":"https://d3codex.com/updateprocessor/update-processor-overview/","api":"https://d3codex.com/api/topics/updateprocessor/update-processor-overview.json"},{"slug":"updateprocessor/using-the-update-processor-as-a-data-processor","title":"Using the Update processor as a data processor","category":"Update Processor","categorySlug":"updateprocessor","summary":"The Update processor can be used as a data processor.","url":"https://d3codex.com/updateprocessor/using-the-update-processor-as-a-data-processor/","api":"https://d3codex.com/api/topics/updateprocessor/using-the-update-processor-as-a-data-processor.json"},{"slug":"updateprocessor/using-the-update-processor-as-a-text-editor","title":"Using the Update processor as a text editor","category":"Update Processor","categorySlug":"updateprocessor","summary":"If no attribute list is specified, the Update processor functions as a text editor. The text edit form requires specifying only the file name and item list (no attribute list). If no macro is present on the file-defining item, the raw item is presented.","url":"https://d3codex.com/updateprocessor/using-the-update-processor-as-a-text-editor/","api":"https://d3codex.com/api/topics/updateprocessor/using-the-update-processor-as-a-text-editor.json"}]}