gtpc2mgk | C/C++ Language Support User's Guide |
This function creates the entry represented by the specified key and stores the passed data values as its contents. The passed key string is must be 64 bytes long.
Format
#include <c$to2.h> long TO2_atBrowseNewKeyPut ( TO2_ENV_PTR env_ptr, const void *key, const void *data, const long *dataLength);
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_NOT_UNIQUE
TO2_ERROR_METHOD
TO2_ERROR_NOT_INIT
TO2_ERROR_PID
TO2_ERROR_UPDATE_NOT_ALLOWED
TO2_ERROR_ZERO_PID
Programming Considerations
Examples
The following example adds data to the dictionary with the key specified.
#include <c$to2.h> /* Needed for TO2 API functions */ #include <stdio.h> /* APIs for standard I/O functions */ long err_code; char *key; char *data; TO2_ENV_PTR env_ptr; /* Pointer to TO2 environment */ long dataLength;
·
·
·
err_code = TO2_atBrowseNewKeyPut (env_ptr, key, &dataLength, data); if (err_code == TO2_ERROR) { err_code = TO2_getErrorCode(env_ptr); { printf("TO2_atBrowseNewKeyPut failed!\n"); process_error(env_ptr); } else { printf("TO2_atBrowseNewKeyPut successful!\n"); } }
Related Information