gtpc2mct | C/C++ Language Support User's Guide |
This function creates an empty log collection using the specified options and assigns a persistent identifier (PID) to the collection.
Format
#include <c$to2.h> long TO2_createKeyedLogWithOptions (TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr, const TO2_OPTION_PTR optionListPtr, const long *entryLength, const long *numberEntries, const long *keyFieldLength, const long *keyFieldDisplacement);
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_DDNAME
TO2_ERROR_ENV
TO2_ERROR_LOCATOR_LGH
Programming Considerations
Examples
The following example creates a persistent keyed log collection.
#include <c$to2.h> /* Needed for TO2 API functions */ #include <stdio.h> /* APIs for standard I/O functions */ TO2_ENV_PTR env_ptr; /* Pointer to the TO2 environment */ TO2_PID collect; /* will hold collection's PID */ u_char ddname[] = "NAME_OF_USER_DD_DEFINITION "; long entryLength; /* Max Entry Length */ long numberEntries; /* Nbr Entry */ long keyFieldLen; /* Key field length */ long keyFieldDisp; /* Key field displacement */ TO2_OPTION_PTR optionListPtr; char recoupname[] = "HOSP0001";
·
·
·
/* invoke TO2 to create option list */ optionListPtr=TO2_createOptionList(env_ptr, TO2_OPTION_LIST_CREATE, /* create options */ TO2_CREATE_SHADOW, /* use shadowing */ TO2_CREATE_DD, /* use provided dd name*/ TO2_CREATE_RECOUP, /* use provided recoup */ TO2_OPTION_LIST_END, /* end of options */ dd_name, /* address of ddname */ recoupname); /* addr of recoup key */ if (optionListPtr == TO2_ERROR) process_error(env_ptr); if (TO2_createKeyedLogWithOptions(&collect, env_ptr, optionListPtr, &numberEntries, &keyFieldLen, &keyFieldDisp) == TO2_ERROR) { printf("TO2_createKeyedLogWithOptions failed!\n"); process_error(env_ptr); } printf("TO2_createKeyedLogWithOptions successful!\n");
Related Information