gtpc2mdcC/C++ Language Support User's Guide

TO2_createSequenceTemp-Create a Temporary Sequence Collection

This function creates a temporary sequence collection and assigns it a persistent identifier (PID). A temporary collection will exist only for the life of the entry control block (ECB) and is deleted when the ECB exits.

Format

#include <c$to2.h>
long  TO2_createSequenceTemp (      TO2_PID_PTR   pid_ptr,
                                    TO2_ENV_PTR   env_ptr,
                              const long         *entryLength);

pid_ptr
The pointer to the location where the temporary PID assigned to the new collection will be returned.

env_ptr
The pointer to the environment as returned by the TO2_createEnv function.

entryLength
The pointer to the length of an element in the collection. The maximum length is 4000 bytes.

Normal Return

The normal return is a positive value.

Error Return

An error return is indicated by a zero. When zero is returned, use the TO2_getErrorCode function to determine the specific error code. For more information, see Error Handling.

The following error codes are common for this function:

TO2_ERROR_DATA_LGH

TO2_ERROR_ENV

Programming Considerations

Examples

The following example creates a temporary sequence collection.

#include <c$to2.h>          /* Needed for TO2 API functions    */
#include <stdio.h>          /* APIs for standard I/O functions */
 
TO2_ENV_PTR    env_ptr;     /* PTR to the TO2 environment      */
TO2_PID        collect;     /* will hold collection's PID      */
long           entryLength; /* PTR to Max Entry Length         */

  ·
  ·
  ·
if (TO2_createSequenceTemp(&collect, env_ptr, &entryLength) == TO2_ERROR) { printf("TO2_createSequenceTemp failed!\n"); process_error(env_ptr); } else { printf("TO2_createSequenceTemp successful!\n"); }
  ·
  ·
  ·
TO2_deleteCollection(&collect, env_ptr);

Related Information