gtpc2mbvC/C++ Language Support User's Guide

TO2_asSequenceCollection-Return Contents As Sequence

This function creates a temporary sequence collection that contains all the elements of the source collection. Duplicate elements are allowed, and the order of the sequence collection is random.

Note:
This function does not support all collections. See Table 47 for collections that are supported for this function.

Format

#include <c$to2.h>
long TO2_asSequenceCollection (const TO2_PID_PTR   source_pid_ptr,
                                     TO2_ENV_PTR   env_ptr,
                                     TO2_PID_PTR   sequenceCollectionPID);

source_pid_ptr
The pointer to the persistent identifier (PID) assigned to the source collection.

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

sequenceCollectionPID
The pointer to where the PID is stored for the temporary sequence collection on return.

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_METHOD

TO2_ERROR_NOT_INIT

TO2_ERROR_PID

TO2_ERROR_ZERO_PID

Programming Considerations

Examples

The following example creates a temporary sequence collection containing all the elements of the source 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 the TO2 environment  */
TO2_PID        sourcePID;         /* holds PID of source collection  */
TO2_PID        sequencePID;       /* will hold PID of sequence col.  */

  ·
  ·
  ·
if (TO2_asSequenceCollection(&sourcePID, env_ptr, &sequencePID) == TO2_ERROR) { printf("TO2_asSequenceCollection failed!\n"); process_error(env_ptr); return; } else { printf("TO2_asSequenceCollection successful!\n"); }
  ·
  ·
  ·
TO2_deleteCollection(sequencePID, env_ptr);

Related Information