Return to setkey.nr CVS log

Up to [CSRG BSD Unix] / 43BSD / ingres / doc / access

Annotation of 43BSD/ingres/doc/access/setkey.nr, revision 1.1.1.1

1.1       root        1: .th SETKEY AM 9/14/77
                      2: .sh NAME
                      3: setkey - provide key values to be used by find
                      4: .sh SYNOPSIS
                      5: .nf
                      6: setkey(d, key, value, domnum)
                      7: struct descriptor      *d;
                      8: char                   key[MAXTUP], *value;
                      9: int                    domnum;
                     10: .fi
                     11: .sh DESCRIPTION
                     12: SETKEY is used to provide values for keyed domains.
                     13: Keys may be
                     14: as large as the largest tuple so the key character array must be
                     15: declared as the same size as a tuple buffer (i.e. length is MAXTUP).
                     16: SETKEY will move the supplied value into the proper position
                     17: in the key and will mark the descriptor to indicate that the value
                     18: has been supplied.
                     19: DOMNUM specifies which domain in the key is being assigned a value.
                     20: VALUE is a pointer to the value which is to be set into the key.
                     21: If a value is being given for a character domain,
                     22: the domain area in the key will be blank padded
                     23: after the value is moved in.
                     24: This is done to eliminate any nulls in character domains.
                     25: If VALUE is 0, (i.e. a null pointer)
                     26: then the tag in the descriptor indicating that a value was
                     27: provided for a domain is reset.
                     28: .sp
                     29: CLEARKEYS should be called prior to any SETKEY calls.
                     30: SETKEY must be called at least once before a call to FIND when 
                     31: find mode is LRANGEKEY, HRANGEKEY or EXACTKEY.
                     32: If find mode is NOKEY then neither
                     33: CLEARKEYS nor SETKEY need be called.
                     34: .sh DIAGNOSTICS
                     35: No value is returned.
                     36: If an error is detected, a SYSERR is generated.
                     37: .sh "TRACE FLAGS"
                     38: 22.8
                     39: .sh "SEE ALSO"
                     40: clearkeys, find, getequal

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.