gtpc2mijC/C++ Language Support User's Guide

TPFxd_archiveEnd-Inform the Archive Facility That the Request Has Ended

This function informs the archive facility that the request has ended and the external device is no longer needed.

Format

#include <c$tpxd.h>
long TPFxd_archiveEnd (TPFxd_extToken *token);

token
The returned token from the TPFxd_archiveStart request.

Normal Return

A return code of 1 indicates a normal return.

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 and then ends the archive process.

#include <c$tpxd.h>
long example()
{
TPFxd_extToken    *token;
enum              tpxd_mode mode;
enum              tpxd_opts access;
 
token = NULL;
mode = WT;
access = IMMEDIATE;
TPFxd_archiveStart (&token, mode, access);
 

  ·
  ·
  ·
TPFxd_archiveEnd (token);
  ·
  ·
  ·
}

Related Information