gtpc2m02C/C++ Language Support User's Guide

C/C++ Language Support User's Guide


Contents

Figures

Tables

Notices

  • Trademarks
  • About This Book

    TPF API Functions

  • Mapping Assembler Macros to C Functions
  • abort-Terminate Program Abnormally
  • access-Determine Whether a File Can Be Accessed
  • addlc-Add a Block to the TPF Task Dispatch List
  • alarm-Schedule an Alarm
  • assert-Verify Condition or Print Diagnostic Message
  • atexit-Call a Function at Normal Program Termination
  • attac-Attach a Detached Working Storage Block
  • attac_ext-Attach a Detached Working Storage Block
  • attac_id-Attach a Detached Working Storage Block
  • cebic_goto_bss-Change MDBF Subsystem to BSS
  • cebic_goto_dbi-Change MDBF Subsystem to DBI
  • cebic_goto_ssu-Change MDBF Subsystem
  • cebic_restore-Restore Previously Saved DBI and SSU IDs
  • cebic_save-Save the Current DBI and SSU IDs
  • chdir-Change the Working Directory
  • chmod-Change the Mode of a File or Directory
  • chown-Change the Owner or Group of a File or Directory
  • cifrc-Cipher Program Interface
  • cinfc-Control Program Interface
  • cinfc_fast-Fast Control Program Interface
  • cinfc_fast_ss-Fast Control Program Interface for Any Active Subsystem
  • clearerr-Reset Error and End-of-File
  • close-Close a File
  • closedir-Close a Directory
  • closelog-Close the System Control Log
  • corhc-Define and Hold a Resource
  • coruc-Unhold a Resource
  • cratc-Search CRAS Status Table
  • creat-Create a New File or Rewrite an Existing File
  • credc, __CREDC-Create a Deferred Entry
  • creec, __CREEC-Create a New ECB with an Attached Block
  • cremc, __CREMC-Create an Immediate Entry
  • cretc, __CRETC-Create a Time-Initiated Entry
  • cretc_level, __CRETCL-Create a Time-Initiated Entry
  • crexc, __CREXC-Create a Low-Priority Deferred Entry
  • crosc_entrc-Cross-Subsystem to Enter a Program and then Return
  • crusa-Free Core Storage Block If Held
  • csonc-Convert System Ordinal Number
  • dbsac-Attach TPF Application Requester Database Support Structure
  • dbsdc-Detach TPF Application Requester Database Support Structure
  • defrc-Defer Processing of Current Entry
  • deleteCache-Delete a Logical Record Cache
  • deleteCacheEntry-Delete a Cache Entry
  • deqc-Dequeue from Resource
  • detac-Detach a Working Storage Block from the ECB
  • detac_ext-Detach a Working Storage Block from the ECB
  • detac_id-Detach a Working Storage Block from the ECB
  • dlayc-Delay Processing of Current Entry
  • dllfree-Free the Supplied Dynamic Link Library (DLL)
  • dllload-Load the DLL and Connect It to the Application
  • dllqueryfn-Obtain a Pointer to a DLL Function
  • dllqueryvar-Obtain a Pointer to a DLL Variable
  • dup-Duplicate an Open File Descriptor
  • dup2-Duplicate an Open File Descriptor to Another
  • ecbptr-ECB Reference
  • enqc-Define and Enqueue a Resource
  • entdc, __ENTDC-Enter a Program and Drop Previous Programs
  • entrc-Enter a Program with Expected Return
  • evinc-Increment Count for Event
  • evnqc-Query Event Status
  • evntc-Define an Internal Event
  • evnwc-Wait for Event Completion
  • exit-Exit an ECB
  • FACE, FACS-Low-Level File Address Compute Functions
  • face_facs-File Address Generation
  • fchmod-Change the Mode of a File or Directory by Descriptor
  • fchown-Change the Owner and Group by File Descriptor
  • fclose-Close File Stream
  • fcntl-Control Open File Descriptors
  • FD_CLR-Remove File Descriptor from the File Descriptor Set
  • FD_COPY-Copy the File Descriptor Set
  • FD_ISSET-Return a Value for the File Descriptor in the File Descriptor Set
  • fdopen-Associate a Stream with an Open File Descriptor
  • FD_SET-Add a File Descriptor to a File Descriptor Set
  • FD_ZERO-Initialize the File Descriptor Set
  • feof-Test End-of-File Indicator
  • ferror-Test for Read/Write Errors
  • fflush-Write Buffer to File
  • fgetc-Read a Character
  • fgetpos-Get File Position
  • fgets-Read a String from a Stream
  • filec-File a Record: Basic
  • filec_ext-File a Record with Extended Options: Basic
  • fileno-Get the File Descriptor from an Open Stream
  • file_record-File a Record: Higher Level
  • file_record_ext-File a Record with Extended Options: Higher Level
  • filnc-File a Record with No Release
  • filnc_ext-File a Record with No Release and Extended Options
  • filuc-File and Unhold a Record
  • filuc_ext-File and Unhold a Record with Extended Options
  • findc-Find a Record
  • findc_ext-Find a Record with Extended Options
  • find_record-Find a Record
  • find_record_ext-Find a Record with Extended Options
  • finhc-Find and Hold a File Record
  • finhc_ext-Find and Hold a File Record with Extended Options
  • finwc-Find a File Record and Wait
  • finwc_ext-Find a File Record and Wait with Extended Options
  • fiwhc-Find and Hold a File Record and Wait
  • fiwhc_ext-Find and Hold a File Record and Wait with Extended Options
  • flipc-Interchange the Status of Two Data Levels
  • flushCache-Flush the Cache Contents
  • fopen-Open a File
  • fprintf, printf, sprintf-Format and Write Data
  • fputc-Write a Character
  • fputs-Write a String
  • fread-Read Items
  • freopen-Redirect an Open File
  • fscanf, scanf, sscanf-Read and Format Data
  • fseek-Change File Position
  • fsetpos-Set File Position
  • fstat-Get Status Information about a File
  • fsync-Write Changes to Direct Access Storage
  • ftell-Get Current File Position
  • ftok-Generate a Token
  • ftruncate-Truncate a File
  • fwrite-Write Items
  • gdsnc-Get Data Set Entry
  • gdsrc-Get General Data Set Record
  • getc, getchar-Read a Character from Input Stream
  • getcc-Obtain Working Storage Block
  • getcwd-Get Path Name of the Working Directory
  • getegid-Get the Effective Group ID
  • getenv-Get Value of Environment Variables
  • geteuid-Get the Effective User ID
  • getfc-Obtain File Pool Address
  • getgid-Get the Real Group ID
  • getgrgid-Access the Group Database by ID
  • getgrnam-Access the Group Database by Name
  • getpc-Get Program and Lock in Core
  • getpid-Obtain a Process ID
  • getppid-Obtain the Parent Process ID
  • getpwnam-Access the User Database by Name
  • getpwuid-Access the User Database by User ID
  • gets-Obtain Input String
  • gettimeofday-Get Time
  • getuid-Get the Real User ID
  • glob-Address TPF Global Field or Record
  • glob_keypoint-Keypoint TPF Global Field or Record
  • glob_lock-Lock and Access Synchronizable TPF Global Field or Record
  • glob_modify-Modify TPF Global Field or Record
  • glob_sync-Synchronize TPF Global Field or Record
  • glob_unlock-Unlock TPF Global Field or Record
  • glob_update-Update TPF Global Field or Record
  • global-Operate on TPF Global Field
  • gsysc-Get Storage from the System Heap
  • inqrc-Convert Resource Application Interface
  • keyrc-Restore Protection Key
  • keyrc_okey-Restore Original Protection Key
  • kill-Send a Signal to a Process
  • levtest-Test Core Level for Occupied Condition
  • link-Create a Link to a File
  • lockc-Lock a Resource
  • lodic-Check System Load and Mark ECB
  • lodic_ext-Check System Load and Mark ECB with Extended Options
  • longc-Set Entry Maximum Existence Time
  • longjmp-Restore Stack Environment
  • lseek-Change the Offset of a File
  • lstat-Get Status of a File or Symbolic Link
  • mail-Process Internet Mail
  • maskc-Modify Program Status Word (PSW) Mask Bits
  • mkdir-Make a Directory
  • mkfifo-Make a FIFO Special File
  • mknod-Make a Character Special File
  • MQBACK-Back Out a Queue
  • MQCLOSE-Close a Queue
  • MQCMIT-Commit a Queue
  • MQCONN-Connect Queue Manager
  • MQDISC-Disconnect Queue Manager
  • MQGET-Get Message from an Open Queue
  • MQINQ-Inquire about Object Attributes
  • MQOPEN-Open a Queue
  • MQPUT-Put a Message on an Open Queue
  • MQPUT1-Put a Single Message on a Queue
  • MQSET-Set Object Attributes
  • newCache-Create a New Logical Record Cache
  • numbc-Query Number of Storage Blocks Available
  • open-Open a File
  • opendir-Open a Directory
  • openlog-Open the System Control Log
  • pausc-Control System Multiprocessor Environment
  • pause-Wait for a Signal
  • perror-Write Error Message to Standard Error Stream
  • pipe-Create an Unnamed Pipe
  • postc-Mark Event Element Completion
  • printf-Format and Write Data
  • progc-Return Program Allocation Table (PAT) Slot Address
  • putc, putchar-Write a Character
  • puts-Put String to Standard Output Stream
  • raisa-General File Get File Address
  • raise-Raise Condition
  • rcunc-Release Core Block and Unhold File Record
  • read-Read from a File
  • readCacheEntry-Read a Cache Entry
  • readdir-Read an Entry from a Directory
  • readlink-Read the Value of a Symbolic Link
  • rehka-Rehook Core Block
  • relcc-Release Working Storage Block
  • relfc-Release File Pool Storage
  • relpc-Release Program from Core Lock
  • remove-Delete a File
  • rename-Rename a File
  • rewind-Set File Position to Beginning of File
  • rewinddir-Reposition a Directory Stream to the Beginning
  • ridcc-SNA RID Conversions
  • rlcha-Release Chained File Records
  • rmdir-Remove a Directory
  • routc-Route a Message
  • rsysc-Release Storage from the System Heap
  • rvtcc-Search Resource Vector Table (RVT) Entries
  • scanf-Scan Input for Variables
  • selec-Select a Thread Application Interface
  • select-Monitor Read, Write, and Exception Status
  • serrc_op-Issue System Error: Operational
  • serrc_op_ext-Issue System Error Extended: Operational
  • serrc_op_slt-Issue System Error SLIST: Operational
  • setbuf-Control Buffering
  • setegid-Set the Effective Group ID
  • setenv-Add, Change, or Delete an Environment Variable
  • seteuid-Set the Effective User ID
  • setgid-Set the Group ID to a Specified Value
  • setjmp-Preserve Stack Environment
  • setuid-Set the Real User ID
  • setvbuf-Control Buffering
  • shmat-Attach Shared Memory
  • shmctl-Shared Memory Control
  • shmdt-Detach Shared Memory
  • shmget-Allocate Shared Memory
  • sigaction-Examine and Change Signal Action
  • sigaddset-Add a Signal to a Signal Set
  • sigdelset-Delete a Signal from a Signal Set
  • sigemptyset-Initialize and Empty a Signal Set
  • sigfillset-Initialize and Fill a Signal Set
  • sigismember-See If a Signal Is a Member of a Signal Set
  • signal-Install Signal Handler
  • sigpending-Examine Pending Signals
  • sigprocmask-Examine and Change Blocked Signals
  • sigsuspend-Set Signal Mask and Wait for a Signal
  • sipcc-System Interprocessor Communication
  • sleep-Suspend the Calling Process
  • snapc-Issue Snapshot Dump
  • sonic-Obtain Symbolic File Address Information
  • stat-Get File Information
  • strerror-Get Pointer to Run-Time Error Message
  • swisc_create-Create New ECB on Specified I-Stream
  • symlink-Create a Symbolic Link to a Path Name
  • syslog-Send a Message to the Control Log
  • systc-Test System Generation Options
  • system-Execute a Command
  • tancc-Transaction Anchor Table Control
  • tape_access-Access a Tape
  • tape_close-Close a General Tape
  • tape_cntl-Tape Control
  • tape_open-Open a General Tape
  • tape_read-Read a Record From General Tape
  • tape_write-Write a Record to General Tape
  • tasnc-Assign General Tape to ECB
  • tbspc-Backspace General Tape and Wait
  • tclsc-Close a General Tape
  • tdspc-Display Tape Status
  • tdspc_q-Display Tape Queue Length
  • tdspc_v-Retrieve VOLSER for a Specified Tape Name
  • tdtac-Issue a User-Specified Data Transfer CCW
  • tmpfile-Create a Temporary File
  • tmpnam-Produce a Temporary Name
  • tmslc-ECB Time Slice Facility
  • topnc-Open a General Tape
  • tourc-Write Real-Time Tape Record/Release Storage Block
  • toutc-Write Real-Time Tape Record
  • tpcnc-Issue a User-Specified Control Operation CCW
  • TPF_CALL_BY_NAME, TPF_CALL_BY_NAME_STUB-Call (Enter) a Program by Name
  • tpf_cfconc-Connect to a Coupling Facility List or Cache Structure
  • tpf_cfdisc-Disconnect from a Coupling Facility List or Cache Structure
  • tpf_cresc-Create Synchronous Child ECBs
  • tpf_decb_create-Create a Data Event Control Block
  • tpf_decb_locate-Locate a Data Event Control Block
  • tpf_decb_release-Release a Data Event Control Block
  • tpf_decb_swapblk-Swap a Storage Block with a Data Event Control Block
  • tpf_decb_validate-Validate a Data Event Control Block
  • tpf_dlckc - Modify Lock and Input/Output Interrupt Status
  • tpf_esfac-Obtain Extended Symbolic File Address Information
  • tpf_fac8c-Low-Level File Address Compute Functions
  • tpf_faczc-File Address Calculation
  • tpf_fa4x4c-Convert a File Address
  • tpf_fork-Create a Child Process
  • tpf_genlc-Generate a Data List
  • tpf_gsvac-Convert an EVM Address to an SVM Address
  • tpf_help-Issue Help Messages
  • tpf_is_RPCServer_auto_restarted-Query If an RPC Server Is Restarted
  • tpf_itrpc-Send Simple Network Management Protocol User Trap
  • tpf_lemic -Lock Entry Management Interface
  • tpf_movec-Move Data between EVM and SVM
  • tpf_movec_EVM-Move Data from One EVM to Another EVM
  • tpf_msg-Issue a Message
  • tpf_process_signals-Process Outstanding Signals
  • tpf_rcrfc-Release a Core Block and File Address
  • tpf_RPC_options-Set TPF- Specific Thread Options
  • tpf_sawnc-Wait for Event Completion with Signal Awareness
  • tpf_select_bsd-Indicates Read, Write, and Exception Status
  • tpf_snmp_BER_encode-Encode SNMP Variables in BER Format
  • tpf_STCK-Store Clock
  • tpf_tcpip_message_cnt-Update the Message Counters for TCP/IP Applications
  • tpf_tm_getToken-Get the Unique Token for the Current Transaction
  • tpf_vipac-Move a VIPA to Another Processor
  • tpf_yieldc-Yield Control
  • tprdc-Read General Tape Record
  • trewc-Rewind General Tape and Wait
  • trsvc-Reserve General Tape
  • tsync-Synchronize a Tape
  • twrtc-Write a Record to General Tape
  • tx_begin-Begin a Global Transaction
  • tx_commit-Commit a Global Transaction
  • tx_open-Open a Set of Resource Managers
  • tx_resume_tpf-Resume a Global Transaction
  • tx_rollback-Roll Back a Global Transaction
  • tx_suspend_tpf-Suspend a Global Transaction
  • uatbc-MDBF User Attribute Reference Request
  • umask-Set the File Mode Creation Mask
  • unfrc-Unhold a File Record
  • unfrc_ext-Unhold a File Record with Extended Options
  • ungetc-Push Character to Input Stream
  • unhka-Unhook Core Block
  • unlink-Remove a Directory Entry
  • unlkc-Unlock a Resource
  • unsetenv-Delete an Environment Variable
  • updateCacheEntry-Add a New or Update an Existing Cache Entry
  • utime-Set File Access and Modification Times
  • vfprintf-Format and Print Data to a Stream
  • vprintf-Format and Print Data to stdout
  • vsprintf-Format and Print Data to a Buffer
  • wait-Wait for Status Information from a Child Process
  • waitc-Wait For Outstanding I/O Completion
  • waitpid-Obtain Status Information from a Child Process
  • WEXITSTATUS-Obtain Exit Status of a Child Process
  • wgtac-Locate Terminal Entry
  • wgtac_ext-Locate Terminal Entry with Extended Options
  • WIFEXITED-Query Status to See If a Child Process Ended Normally
  • WIFSIGNALED-Query Status to See If a Child Process Ended Abnormally
  • write-Write Data to a File Descriptor
  • WTERMSIG-Determine Which Signal Caused the Child Process to Exit
  • wtopc-Send System Message
  • wtopc_insert_header-Save Header for wtopc
  • wtopc_routing_list-Save Routing List for wtopc
  • wtopc_text-Send System Message
  • xa_commit-Commit Work Done for a Transaction Branch
  • xa_end-End Work Performed for a Transaction Branch
  • xa_open-Open a Resource Manager
  • xa_prepare-Prepare to Commit
  • xa_recover-Get a List of Prepared Transaction Branches
  • xa_rollback-Roll Back Work Done for a Transaction Branch
  • xa_start-Start Work for a Transaction Branch
  • TPF/APPC Basic Conversation Functions

  • General Format
  • Return Codes for Basic Conversation Functions
  • Programming Considerations for Basic Conversation Functions
  • tppc_activate_on_confirmation-Activate a Program after Confirmation Received
  • tppc_activate_on_receipt-Activate a Program after Information Received
  • tppc_allocate-Allocate a Conversation
  • tppc_confirm-Send a Confirmation Request
  • tppc_confirmed-Send a Confirmation Reply
  • tppc_deallocate-Deallocate a Conversation
  • tppc_flush-Flush Data from Local LU Buffer
  • tppc_get_attributes-Get Information about a Conversation
  • tppc_get_type-Get Conversation Type
  • tppc_post_on_receipt-Set Posting Active for a Conversation
  • tppc_prepare_to_receive-Change to Receive State
  • tppc_receive-Receive Information
  • tppc_request_to_send-Request Change to Send State
  • tppc_send_data-Send Data to Remote Transaction Program
  • tppc_send_error-Send Error Notification
  • tppc_test-Test Conversation
  • tppc_wait-Wait for Posting
  • TPF/APPC Mapped Conversation Functions

  • TPF/APPC Mapped Conversation Interface Overview
  • Return Codes for Mapped Conversation Functions
  • cmaccp-Accept a Conversation
  • cmallc-Allocate a Conversation
  • cmcfm-Send a Confirmation Request
  • cmcfmd-Send a Confirmation Reply
  • cmdeal-Deallocate a Conversation
  • cmecs-Extract the Conversation State
  • cmemn-Extract the Mode Name
  • cmepln-Extract the Partner LU Name
  • cmesl-Extract the Sync Level
  • cmflus-Flush Data from Buffer of Local LU
  • cminit-Initialize a Conversation
  • cmptr-Prepare to Receive Data
  • cmrcv-Receive Information
  • cmrts-Request Change to Send State
  • cmsdt-Set the Deallocate_Type Characteristic
  • cmsed-Set the Error_Direction Characteristic
  • cmsend-Send Data to Remote Transaction Program
  • cmserr-Send Error Notification
  • cmsmn-Set the Mode_Name Characteristic
  • cmspln-Set the Partner_LU_Name Characteristic
  • cmsptr-Set the Prepare_To_Receive_Type Characteristic
  • cmsrc-Set the Return_Control Characteristic
  • cmssl-Set the Sync_Level Characteristic
  • cmsst-Set the Send_Type Characteristic
  • cmstpn-Set the TP_Name Characteristic
  • cmtrts-Test for Request_To_Send Notification
  • TPF Collection Support: Environment Functions

  • Type Definitions
  • Retrieving Error Information
  • Error Code Summary
  • TO2_createEnv-Create an Environment Block
  • TO2_deleteEnv-Delete an Environment Block
  • TO2_getErrorCode-Retrieve the Error Code Value
  • TO2_getErrorText-Retrieve the Associated Error Text
  • TPF Collection Support: Non-Cursor

  • Collection Support for Non-Cursor APIs
  • TO2_add-Add an Element to a Collection
  • TO2_addAllFrom-Add All from Source Collection
  • TO2_addAtIndex-Insert an Element in an Sequence Collection
  • TO2_addKeyPath-Add a Key Path to a Collection
  • TO2_addRecoupIndexEntry-Add an Entry to a Recoup Index
  • TO2_asOrderedCollection-Return Contents As Ordered
  • TO2_asSequenceCollection-Return Contents As Sequence
  • TO2_associateRecoupIndexWithPID-Create a PID to Index Association
  • TO2_asSortedCollection-Return Contents As Sorted Bag
  • TO2_at-Return the Specified Element by Index
  • TO2_atKey-Return the Specified Element by Key
  • TO2_atKeyPut-Update the Specified Element Using a Key
  • TO2_atKeyWithBuffer-Return the Specified Element
  • TO2_atNewKeyPut-Add a New Key and Element
  • TO2_atPut-Update the Specified Element
  • TO2_atRBA-Retrieve Data from a BLOB
  • TO2_atRBAPut-Store Data in a BLOB
  • TO2_atRBAWithBuffer-Retrieve Data from a BLOB
  • TO2_atWithBuffer-Retrieve an Element from a Collection
  • TO2_capture-Capture a Collection to an External Device
  • TO2_copyCollection-Make a Persistent Copy of the Collection
  • TO2_copyCollectionTemp-Make a Temporary Copy of the Collection
  • TO2_copyCollectionWithOptions-Make a Copy Using Options
  • TO2_createArray-Create a Persistent Array Collection
  • TO2_createArrayTemp-Create a Temporary Array Collection
  • TO2_createArrayWithOptions-Create an Empty Array Collection
  • TO2_createBag-Create a Persistent Bag Collection
  • TO2_createBagTemp-Create a Temporary Bag Collection
  • TO2_createBagWithOptions-Create an Empty Bag Collection
  • TO2_createBLOB-Create a Persistent BLOB Collection
  • TO2_createBLOBTemp-Create a Temporary BLOB Collection
  • TO2_createBLOBWithOptions-Create an Empty BLOB Collection
  • TO2_createDictionary-Create a Persistent Dictionary Collection
  • TO2_createDictionaryTemp-Create a Temporary Dictionary
  • TO2_createDictionaryWithOptions-Create an Empty Dictionary Collection
  • TO2_createKeyBag-Create a Persistent Key Bag Collection
  • TO2_createKeyBagTemp-Create a Temporary Key Bag Collection
  • TO2_createKeyBagWithOptions-Create an Empty Key Bag Collection with Options
  • TO2_createKeyedLog-Create a Persistent Keyed Log Collection
  • TO2_createKeyedLogTemp-Create a Temporary Keyed Log Collection
  • TO2_createKeyedLogWithOptions-Create an Empty Keyed Log Collection with Options
  • TO2_createKeySet-Create a Persistent Key Set Collection
  • TO2_createKeySetTemp-Create a Temporary Key Set Collection
  • TO2_createKeySetWithOptions-Create an Empty Key Set Collection
  • TO2_createKeySortedBag-Create a Persistent Key Sorted Bag Collection
  • TO2_createKeySortedBagTemp-Create a Temporary Sorted Key Bag
  • TO2_createKeySortedBagWithOptions-Create an Empty Key Sorted Bag with Options
  • TO2_createKeySortedSet-Create an Empty Persistent Key Sorted Set Collection
  • TO2_createKeySortedSetTemp-Create a Temporary Key Sorted Set
  • TO2_createKeySortedSetWithOptions-Create an Empty Key Sorted Set Collection
  • TO2_createLog-Create an Empty Persistent Log Collection
  • TO2_createLogTemp-Create a Temporary Log Collection
  • TO2_createLogWithOptions-Create an Empty Log Collection with Options
  • TO2_createOptionList-Create a TPF Collection Support Option List
  • TO2_createOrder-Create a Persistent Ordered Collection
  • TO2_createOrderTemp-Create a Temporary Ordered Collection
  • TO2_createOrderWithOptions-Create an Empty Ordered Collection with Options
  • TO2_createRecoupIndex-Create a Recoup Index
  • TO2_createSequence-Create a Persistent Sequence Collection
  • TO2_createSequenceTemp-Create a Temporary Sequence Collection
  • TO2_createSequenceWithOptions-Create an Empty Sequence Collection with Options
  • TO2_createSet-Create a Persistent Set Collection
  • TO2_createSetTemp-Create a Temporary Set for the Collection
  • TO2_createSetWithOptions-Create an Empty Set Collection with Options
  • TO2_createSort-Create a Persistent Sorted Collection
  • TO2_createSortedBag-Create an Empty Persistent Sorted Bag Collection
  • TO2_createSortedBagTemp-Create a Temporary Sorted Bag Collection
  • TO2_createSortedBagWithOptions-Create an Empty Sorted Bag Collection with Options
  • TO2_createSortedSet-Create a Persistent Sorted Set Collection
  • TO2_createSortedSetTemp-Create a Temporary Sorted Set Collection
  • TO2_createSortedSetWithOptions-Create an Empty Sorted Set Collection with Options
  • TO2_createSortTemp-Create a Temporary Sorted Collection
  • TO2_createSortWithOptions-Create an Empty Sorted Collection with Options
  • TO2_definePropertyForPID-Define or Change a Property for a Collection
  • TO2_definePropertyWithModeForPID-Define a Property with a Mode
  • TO2_deleteAllPropertiesFromPID-Delete All Defined Properties
  • TO2_deleteCollection-Delete a Collection
  • TO2_deletePropertyFromPID-Delete a Property
  • TO2_deleteRecoupIndex-Delete a Recoup Index
  • TO2_deleteRecoupIndexEntry-Delete an Entry from an Index
  • TO2_getAllPropertyNamesFromPID-Return Property Names
  • TO2_getBLOB-Retrieve the Contents of a BLOB
  • TO2_getBLOBwithBuffer-Retrieve Contents of a BLOB Using a Passed Buffer
  • TO2_getCollectionAccessMode -- Retrieve the Access Mode of a Collection
  • TO2_getCollectionKeys-Get the Primary Key Values of the Collection
  • TO2_getCollectionType-Get the Type Value of the Collection
  • TO2_getDRprotect -- Retrieve Dirty-Reader Protection Status
  • TO2_getMaxDataLength-Retrieve the Maximum Data Length Value
  • TO2_getMaxKeyLength-Retrieve the Maximum Key Length Value
  • TO2_getPropertyValueFromPID-Retrieve a Property Value
  • TO2_getSortFieldValues-Retrieve the Sort Field Values
  • TO2_includes-Search Collection for Element Equal to the Argument
  • TO2_isCollection-Test If PID Is for a Collection
  • TO2_isPropertyDefinedForPID-Test If a Property Is Already Defined
  • TO2_isTemp-Determine If Collection Is Temporary or Persistent
  • TO2_makeEmpty-Delete All Elements from a Collection
  • TO2_maxEntry-Return the Maximum Number of Elements in a Collection
  • TO2_readOnly-Get the Read-Only Attribute of the Collection
  • TO2_removeIndex-Remove Element from the Index
  • TO2_removeKey-Remove the Key-Entry Pair
  • TO2_removeKeyPath-Remove a Key Path from a Collection
  • TO2_removeRBA-Remove an Area from a BLOB
  • TO2_removeRecoupIndexFromPID-Remove a PID to Index Association
  • TO2_removeValue-Remove Value
  • TO2_removeValueAll-Remove All Matching Values from the Collection
  • TO2_replaceBLOB-Replace the Contents of a BLOB with New Data
  • TO2_restore-Restore a Previously Captured Collection
  • TO2_restoreAsTemp-Restore a Collection as a Temporary Collection
  • TO2_restoreWithOptions-Restore a Collection Using the Specified Options
  • TO2_setCollectionAccessMode -- Set the Access Mode of a Collection
  • TO2_setDRprotect -- Set Dirty-Reader Protection On
  • TO2_setReadOnly-Set the Read-Only Attribute of the Collection
  • TO2_setSize-Set the Size of the BLOB
  • TO2_size-Return the Size of the Collection
  • TO2_writeNewBLOB-Create a New BLOB and Add the Passed Data
  • TPF Collection Support: Cursors

  • Supported Collection Classes for Cursor APIs
  • TO2_addAtCursor-Insert an Element in a Sequence Collection
  • TO2_allElementsDo-Iterate over All Elements
  • TO2_atCursor-Return the Element Pointed to by the Cursor
  • TO2_atCursorPut-Store Element Where Cursor Points
  • TO2_atCursorWithBuffer-Return the Element Pointed to by the Cursor
  • TO2_atEnd-Test If the Cursor Is at the End of the Collection
  • TO2_atLast-Test If the Cursor Points to the Last Element
  • TO2_createCursor-Create a Nonlocking Cursor
  • TO2_createReadWriteCursor-Create a Locking Cursor
  • TO2_cursorMinus-Decrement Cursor to Previous Element
  • TO2_cursorPlus-Increment Cursor to Next Element
  • TO2_deleteCursor-Delete a Previously Created Cursor
  • TO2_first-Point Cursor to First Element
  • TO2_getCurrentKey-Retrieve the Current Key
  • TO2_getCurrentKeyWithBuffer-Retrieve the Current Key in the Buffer
  • TO2_index-Return Current Position Index Value
  • TO2_isEmpty-Test If Collection Is Empty
  • TO2_key-Return Current Key Value
  • TO2_keyWithBuffer-Return Current Key Value in the Buffer
  • TO2_last-Point Cursor at Last Element
  • TO2_locate-Locate Key and Point Cursor to Its Element
  • TO2_more-Test for More Elements to Process
  • TO2_next-Increment and Return the Next Element
  • TO2_nextPut-Store This Element As the Next Element
  • TO2_nextRBAfor-Return the Next Specified Number of Bytes
  • TO2_nextWithBuffer-Increment and Return the Next Element
  • TO2_peek-Return the Next Element with No Cursor Movement
  • TO2_peekWithBuffer-Return the Next Element
  • TO2_previous-Return the Previous Element
  • TO2_previousWithBuffer-Return the Previous Element in the Specified Buffer
  • TO2_remove-Remove the Element Pointed to by the Cursor
  • TO2_reset-Reset Cursor to Point to First Element
  • TO2_setKeyPath-Set a Cursor to Use a Specific Key Path
  • TO2_setPositionIndex-Point Cursor at Specified Position
  • TO2_setPositionValue-Point Cursor at Specified Element
  • TPF Collection Support: Dictionary

  • Data Store Application Dictionary
  • TO2_atDSdictKey-Retrieve the Element Using the Specified Key
  • TO2_atDSdictKeyPut-Replace the Element Using the Key
  • TO2_atDSdictNewKeyPut-Store the Element Using the New Key
  • TO2_atDSsystemKey-Retrieve the Element Using the Specified Key
  • TO2_atDSsystemKeyPut-Replace the Element Using the Key
  • TO2_atDSsystemNewKeyPut-Store the Element Using the New Key
  • TO2_atTPFKey-Retrieve the Element Using the Specified Key
  • TO2_atTPFKeyPut-Replace the Element Using the Specified Key
  • TO2_atTPFNewKeyPut-Store the Element Using the New Key
  • TO2_atTPFsystemKey-Retrieve the Element Using the Specified Key
  • TO2_atTPFsystemKeyPut-Replace the Element Using the Specified Key
  • TO2_atTPFsystemNewKeyPut-Store the Element Using the New Key
  • TO2_getDSdictPID-Get the Dictionary PID of a Data Store
  • TO2_getTPFDictPID-Get the PID of the TPF Dictionary
  • TO2_removeDSdictKey-Remove the Element Using the Key
  • TO2_removeDSsystemKey-Remove the Element Using the Key
  • TO2_removeTPFKey-Remove the Element from the TPF Dictionary
  • TO2_removeTPFsystemKey-Remove the Element from the TPF System Dictionary
  • TPF Collection Support: Browser

  • TO2_atBrowseKey-Retrieve the Element Using the Specified Key from the Browser Dictionary
  • TO2_atBrowseKeyPut-Replace the Element Using the Specified Key from the Browser Dictionary
  • TO2_atBrowseNewKeyPut-Store the Element Using the Specified Key in the Browser Dictionary
  • TO2_changeDD-Change a Data Definition
  • TO2_changeDS-Change the Attributes of a Data Store
  • TO2_convertClassName-Convert EBCDIC Class Name to Class Index
  • TO2_convertMethodName-Convert Method Name to Entry Address
  • TO2_createDD-Create a Data Definition
  • TO2_createDS-Create a Data Store
  • TO2_createDSwithOptions-Create a Data Store with an Option List
  • TO2_createPIDinventoryKey-Create PID Inventory Key from PID
  • TO2_defineBrowseNameForPID-Assign a Browse Name to a Collection
  • TO2_deleteBrowseName-Delete a Collection Name from the Browser Dictionary
  • TO2_deleteDD-Delete a Data Definition
  • TO2_deleteDS-Delete a Data Store
  • TO2_getBrowseDictPID-Get the Browser Dictionary PID
  • TO2_getClassAttributes-Get Attributes of a Class
  • TO2_getClassDocumentation-Copy Documentation for a Class
  • TO2_getClassInfo-Get Information for a Class
  • TO2_getClassNames-Convert EBCDIC Class Name to Index
  • TO2_getClassTree-Get an Inheritance Tree for a Class
  • TO2_getCollectionAttributes-Get the Attributes of the Collection
  • TO2_getCollectionName-Get the Class Name of a Collection
  • TO2_getCollectionParts-Get the Part Names of the Collection
  • TO2_getCreateTime-Copy Created Time Stamp of the Collection
  • TO2_getDDAttributes-Get the Current DD Attribute Values
  • TO2_getDirectoryForRRN-Get the Current Directory for the Specified RRN
  • TO2_getDSAttributes-Get the Attributes of the Data Store
  • TO2_getDSnameForPID-Determine the DS Name for a PID
  • TO2_getKeyPathAttributes-Retrieve the Attributes of Key Paths
  • TO2_getListDDnames-Retrieve the Defined Data Definition Names
  • TO2_getListDScollections-Retrieve the Data Store System Collections
  • TO2_getListDSnames-Retrieve the Defined Data Store Names
  • TO2_getListUsers-Get a List of Defined Users
  • TO2_getMethodDocumentation-Copy Documentation for a Method
  • TO2_getMethodNames-Get Method Names for a Class
  • TO2_getNumberOfRecords-Return the Number of Records Used
  • TO2_getPathInfoFor-Retrieve Path Information for a Collection Structure
  • TO2_getPIDforBrowseName-Retrieve the PID Associated with the Name
  • TO2_getPIDinventoryEntry-Get PID Inventory Entry for PID
  • TO2_getPIDinventoryPID-Get PID of PID Inventory of the Data Store
  • TO2_getRecordAttributes-Get Attributes of a Record File Address
  • TO2_getRecoupIndex-Get an Index
  • TO2_getRecoupIndexForPID-Retrieve Associated Recoup Index Name
  • TO2_getUserAttributes-Get User Attributes
  • TO2_isDDdefined-Test If DD Name Is Defined
  • TO2_isExtended-Internal Format of Collections
  • TO2_migrateCollection-Migrate a Collection
  • TO2_migrateDS-Migrate a Data Store
  • TO2_reclaimPID-Reclaim a PID
  • TO2_reconstructCollection-Reconstruct Collection
  • TO2_recoupCollection-Return Head of Chain File Addresses
  • TO2_recoupDS-Return a List of Internal PIDs to Be Recouped
  • TO2_recoupPT-Clear the Pool Reuse Table
  • TO2_recreateDS-Re-create a Data Store
  • TO2_removeBrowseKey-Remove the Element Using the Specified Key
  • TO2_restart-Restart TPF Collection Support at Cycle-Up
  • TO2_setGetTextDump-Set Text Dump On or Off
  • TO2_setMethodTrace-Set Method Trace On or Off
  • TO2_taskDispatch-Dispatch a TPF Collection Support Task
  • TO2_validateCollection-Cause a Collection to Be Validated
  • TO2_validateKeyPath-Cause a Key Path to Be Validated
  • TPF Collection Support: Independent APIs

  • TO2_class-Retrieve the User Class ID of the Collection
  • TO2_convertBinPIDtoEBCDIC-Make a PID Printable
  • TO2_convertEBCDICtoBinPID-Convert EBCDIC String to PID
  • TO2_deletePID-Delete a Persistent Identifier and Its Backing Store
  • TO2_setClass-Set the User Class ID of the Collection
  • External Device Support

  • Initial Setup
  • Writing Records
  • Retrieving Data
  • Error Codes
  • TPFxd_archiveEnd-Inform the Archive Facility That the Request Has Ended
  • TPFxd_archiveStart-Start the Archive Support Facility
  • TPFxd_close-Signal the End of a TPFxd_open Request
  • TPFxd_getPosition-Retrieve Current Positioning Information
  • TPFxd_getPrevPosition-Retrieve Previous Positioning Information
  • TPFxd_getVOLSER-Retrieve Current VOLSER and Media Type
  • TPFxd_getVOLSERlist-Retrieve a List of VOLSERs and Media Type
  • TPFxd_nextVolume-Advance to the Next Volume when Reading or Writing
  • TPFxd_open-Fulfill Any Mount or Positioning Required
  • TPFxd_read-Read from an External Device into a Buffer
  • TPFxd_readBlock-Read into a Core Block from an External Device
  • TPFxd_setPosition-Set Current Position of the External Device
  • TPFxd_sync-Verify Queued Information
  • TPFxd_write-Write to an External Device
  • TPFxd_writeBlock-Write Core Block Images to the External Device
  • Appendix A. Conformance of TPF C Support to ANSI/ISO Standards

  • Implementation-Defined Behavior of the TPF C Run-Time Library
  • Appendix B. Standard C Header Files Supported by the TPF 4.1 System

    Appendix C. Compiler Functions Supported as TPF 4.1 Extensions

    Appendix D. C/C++ Functions Supported by the TPF 4.1 System but Not Documented

  • Standard C/C++ Library Functions
  • XML Parser for C++ (XML4C) Version 3.5.1 Classes
  • Appendix E. Programming Support for the TPF File System

  • TPF File System C Functions
  • TPF-Supplied User and Group Names
  • Adding a User-Defined Device Driver
  • Special Files
  • Device Drivers and Commit Scopes
  • User-Defined Device Driver Functions
  • TPF_FSDD_APPEND-Write Beginning at the End of a File
  • TPF_FSDD_CLOSE-Close a File
  • TPF_FSDD_GET-Read From a File
  • TPF_FSDD_OPEN-Open a File
  • TPF_FSDD_POLL-Select or Poll an Open File Descriptor
  • TPF_FSDD_POLL_CLEAN-Select or Poll Cleanup of an Open File Descriptor
  • TPF_FSDD_PUT-Write to a File
  • TPF_FSDD_RESIZE-Change the Size of a File
  • TPF_FSDD_SIZE-Get the Size of a File
  • TPF_FSDD_SYNC-Synchronize the File Data
  • Appendix F. GNTAGH User's Guide

  • C Global Tagnames
  • Program Parts List
  • Creating or Updating C Globals on VM
  • Creating or Updating C Globals on MVS
  • Format of Global Tags
  • GNTAGH Messages
  • GNTAGH Program Logic Flow
  • Sample Output
  • Appendix G. IPRSE - A Parser Utility for TPF Systems

  • Parser Options That Affect How the Input String Matches the Grammar
  • Special Characters for Input String Syntax
  • Defining a Grammar
  • IPRSE_parse-Parse a Text String against a Grammar
  • IPRSE_bldprstr-Initializing the Output Structure
  • Index