gtpc2mcv | C/C++ Language Support User's Guide |
This function creates a temporary collection for the key set 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_createKeySetTemp ( TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr, const long *entryLength, const long *keyLength);
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
TO2_ERROR_LOCATOR_LGH
Programming Considerations
Examples
The following example creates a temporary key set 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; /* Max Entry Length */ long keyLength; /* Key field length */
·
·
·
if (TO2_createKeySetTemp(&collect, env_ptr, &entryLength, &keyLength) == TO2_ERROR) { printf("TO2_createKeySetTemp failed!\n"); process_error(env_ptr); } else { printf("TO2_createKeySetTemp successful!\n"); }
·
·
·
TO2_deleteCollection(&collect, env_ptr);
Related Information