Fuxedo logotpexport()

render a typed buffer in portable form

Synopsis

#include <atmi.h>

int tpexport(char *ibuf, long ilen, char *ostr,
             long *olen, long flags);

Description

tpexport() renders a typed buffer into a machine-independent form suitable for files, pipes, or byte streams; tpimport() rebuilds the buffer from that form. *olen carries the size of ostr on entry and receives the written length. The export preserves the type, so the rebuilt buffer needs no tpalloc from the caller.

Arguments

ArgumentDescription
ibuf, ilenSource buffer and length; ilen 0 for self-describing types.
ostr, olenOutput storage; *olen is its size on entry and the written length on return.
flags0, or TPEX_STRING for the text form.

Flags

FlagDescription
TPEX_STRINGExport in the readable text form instead of the binary form.
TPEX_XDR64LONG64-bit long encoding (22.x headers only).

Errors (tperrno)

CodeDescription
TPEINVALBad buffer, sizes, or flags.
TPEOS, TPESYSTEMPlatform failure, including a short ostr.

12.2 vs 22.1

Unknown flag bits are rejected with TPEINVAL on 12.2 and accepted on 22.1. TPEX_XDR64LONG only exists in the 22.x headers.

Example

Full source: docs/api/examples/buffers.c (build and run with make -C docs/api/examples check TUXDIR=<install>); the lines documenting tpexport() are highlighted.

// tpalloc()/tptypes()/tpfree() example: typed buffer lifecycle.

#include <stdio.h>
#include <string.h>
#include <atmi.h>

int main(void) {
  char *buf = tpalloc("STRING", NULL, 64);
  if (buf == NULL) {
    fprintf(stderr, "tpalloc failed: tperrno=%d\n", tperrno);
    return 1;
  }

  char type[8] = {0};
  char subtype[16] = {0};
  long len = tptypes(buf, type, subtype);
  if (len == -1) {
    fprintf(stderr, "tptypes failed: tperrno=%d\n", tperrno);
    tpfree(buf);
    return 1;
  }
  printf("type=%s subtype=%s len=%ld\n", type, subtype, len);

  strcpy(buf, "hello");

  // tpexport renders a typed buffer into a portable form that
  // tpimport rebuilds
  char exported[256];
  long elen = sizeof(exported);
  if (tpexport(buf, 0, exported, &elen, 0) == -1) {
    fprintf(stderr, "tpexport failed: tperrno=%d\n", tperrno);
    tpfree(buf);
    return 1;
  }

  // tpimport rebuilds the buffer; *obuf points at the target buffer
  // and *olen carries its size (22.x grows the buffer when the data
  // does not fit)
  char *back = tpalloc("STRING", NULL, 128);
  long blen = 128;
  if (back == NULL || tpimport(exported, elen, &back, &blen, 0) == -1) {
    fprintf(stderr, "tpimport failed: tperrno=%d\n", tperrno);
    tpfree(buf);
    tpfree(back);
    return 1;
  }
  printf("roundtrip: %s\n", back);
  tpfree(back);

  tpfree(buf);
  return 0;
}

See also: tpimport, tpalloc.

fuxedo: supported. Cross-checked against Oracle Tuxedo 12.2.2 and 22.1 with the API hardening suite.