mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc clarifications regarding use of varlena.

Browse Source 
Jay Levitt, reviewed by Tom Lane.
This commit is contained in:
Robert Haas 2012-03-22 15:45:42 -04:00
parent e83f827f5a
commit fdf719cd28
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/src/sgml/xfunc.sgml
View File

@ -1767,7 +1767,8 @@ typedef struct
<para>
Finally, all variable-length types must also be passed
by reference. All variable-length types must begin
with a length field of exactly 4 bytes, and all data to
with an opaque length field of exactly 4 bytes, which will be set
by SET_VARSIZE; never set this field directly! All data to
be stored within that type must be located in the memory
immediately following that length field. The
length field contains the total length of the structure,
@ -1833,7 +1834,7 @@ memcpy(destination->data, buffer, 40);
]]>
</programlisting>
<literal>VARHDRSZ</> is the same as <literal>sizeof(int4)</>, but
<literal>VARHDRSZ</> is the same as <literal>sizeof(int32)</>, but
it's considered good style to use the macro <literal>VARHDRSZ</>
to refer to the size of the overhead for a variable-length type.
Also, the length field <emphasis>must</> be set using the