gtpc2mgd | C/C++ Language Support User's Guide |
This function locates the entry in the data store (DS) symbol dictionary and removes it from the dictionary. The passed key is assumed to be 64 bytes in length.
Format
#include <c$to2.h> long TO2_removeDSdictKey ( TO2_ENV_PTR env_ptr, const void *key);
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_FOUND
Programming Considerations
A commit scope will be created for the TO2_removeDSdictKey request. If the request is successful, the scope will be committed. If an error occurs while processing the TO2_removeDSdictKey request, the scope will be rolled back.
Examples
The following example removes an element from 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 "; TO2_ERR_CODE err_code; /* TO2 error code value */ TO2_ERR_TEXT_PTR err_text_ptr; /* TO2 error code text pointer */
·
·
·
if (TO2_removeDSdictKey(env_ptr, key) == TO2_ERROR) { printf("TO2_removeDSdictKey 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_removeDSdictKey successful!\n");
·
·
·
Related Information