gtpc2mg1 | C/C++ Language Support User's Guide |
This function creates the entry in the data store (DS) symbol dictionary represented by the specified key and stores the passed data values as its contents. The passed key is assumed to be 64 bytes in length.
Format
#include <c$to2.h> long TO2_atDSdictNewKeyPut ( 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_ENV
TO2_ERROR_LOCATOR_NOT_UNIQUE
Programming Considerations
A commit scope will be created for the TO2_atDSdictNewKeyPut request. If the request is successful, the scope will be committed. If an error occurs while processing the TO2_atDSdictNewKeyPut request, the scope will be rolled back.
Examples
The following example adds a new element to the TPFCS symbol dictionary for the specified data store.
#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 TO2 Environment */ char key[64] = "Dictionary.Symbol.Key "; char data[] = "This.is.some.data.for.the.TO2.Class.Dictionary"; long dataLength = sizeof(data); TO2_ERR_CODE err_code; /* TO2 error code value */ TO2_ERR_TEXT_PTR err_text_ptr; /* TO2 error code text pointer */
·
·
·
if (TO2_atDSdictNewKeyPut(env_ptr, key, data, &dataLength) == TO2_ERROR) { printf("TO2_atDSdictNewKeyPut failed!\n"); err_code = TO2_getErrorCode(env_ptr); err_text_ptr = TO2_getErrorText(env_ptr, err_code); printf("err_text_ptr is %s\n", err_text_ptr); } else printf("TO2_atDSdictNewKeyPut successful!\n");
·
·
·
Related Information