gtpc2mikC/C++ Language Support User's Guide

TPFxd_archiveStart-Start the Archive Support Facility

This function opens the archive interface and activates archiving external device support.

Format

#include <c$tpxd.h>
long  TPFxd_archiveStart (     TPFxd_extToken  **token,
                          enum tpxd_mode         mode,
                          enum tpxd_opts         options);

token
A pointer to the token that will be allocated for this request.

mode
The mode is one of the following:

WT
Open for a nonshared write.

WS
Open for a shared write.

options
The options are listed in the c$tpxd.h header file.

Normal Return

The normal return is a positive value.

The **token will be updated to point to the token that was allocated for this request.

Error Return

An error return is indicated by a negative return code. For a list of error codes applicable to this function, see Error Codes.

Programming Considerations

Examples

The following example starts the archive process for a device that allows immediate data retrieval.

#include <c$tpxd.h>
long example()
 
{
TPFxd_extToken   *token;
enum             tpxd_mode mode;
enum             tpxd_opts access;
 
 
mode = WT;
access = IMMEDIATE;
TPFxd_archiveStart (&token, mode, access);
printf("token address/return code is %i\n",token);
}

Related Information