gtpc2midC/C++ Language Support User's Guide

TO2_setClass-Set the User Class ID of the Collection

This function assigns a user class identifier (ID) to a collection. The maximum value for the class ID is 32 bytes.

Format

#include <c$to2.h>
long  TO2_setClass (const TO2_PID_PTR   pid_ptr,
                          TO2_ENV_PTR   env_ptr,
                    const void         *class);

pid_ptr
The pointer to the persistent identifier (PID) of the collection.

env_ptr
The pointer to the environment as returned by the TO2_createEnv function.

class
The pointer to an area that contains the class value that will be assigned to the collection.

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

A commit scope will be created for the TO2_setClass request. If the request is successful, the scope will be committed. If an error occurs while processing the TO2_setClass request, the scope will be rolled back.

Examples

The following example sets a user class ID value for a specified 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;
 
char classID[32] = "TO2.User.Class.ID               ";
 
TO2_ERR_CODE     err_code;        /* TO2 error code value             */
TO2_ERR_TEXT_PTR err_text_ptr;    /* TO2 error code text pointer      */

  ·
  ·
  ·
if (TO2_setClass(&blob, env_ptr, classID) == TO2_ERROR) { printf("TO2_setClass failed!\n"); process_error(env_ptr); } else printf("TO2_setClass successful!\n");
  ·
  ·
  ·

Related Information

TO2_class-Retrieve the User Class ID of the Collection.