gtpc2mes | C/C++ Language Support User's Guide |
This function marks a persistent identifier (PID) as read-only. Once this method has been activated for a PID, the TO2_restore function will no longer work and the PID can never be replaced, added to, or updated. It can be deleted by removing the PID.
Format
#include <c$to2.h> long TO2_setReadOnly (const TO2_PID_PTR pid_ptr, TO2_ENV_PTR env_ptr);
Normal Return
The normal return is a positive value.
Error Return
An error return is indicated by a zero return code. 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_PID
Programming Considerations
Examples
The following example sets the read-only attribute for a 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 TO2 Environment */ TO2_PID blob;
·
·
·
if (TO2_setReadOnly(&blob, env_ptr) == TO2_ERROR) { printf("TO2_setReadOnly failed!\n"); process_error(env_ptr); } else printf("TO2_setReadOnly successful!\n");
·
·
·
Related Information