removed generated
[rrq/rrqforth.git] / adoc / p_str2temp.adoc
1 // temp.asm:    WORD p_str2temp,'STR>TEMP'
2
3 anchor:p_str2temp[]
4
5 === Word: STR>TEMP
6
7 ****
8 Data stack: ( char* n -- char* n )
9 ****
10
11 "STR>TEMP" is a function word that copies a given string plus a
12 terminating NUL character into a <<p_tempspace,TEMPSPACE>> snippet,
13 all preceded by a length cell. It returns a pointer for to the text in
14 the snippet and its length, excluding the NUL character at end and the
15 length cell before tie text.
16
17 .copied string
18 [caption='Layout for ']
19 ----
20         length: 8 bytes
21 returned char*: n bytes 
22            nul: 1 byte
23 ----
24