NetRemoteCopy or Net32RemoteCopy

The NetRemoteCopy API copies one or more files from one location to another on a remote server.

Restrictions

This API can be called from OS/2 workstations, but both the source and destination drives must be redirected drives. (See the sourcepath and destpath parameters for a description.)

Syntax

#include <netcons.h>
#include <remutil.h>
 
NetRemoteCopy(sourcepath, destpath,
          sourcepass, destpass,
          openflags, copyflags,
          buf, usBuflen);            /* 16 bit */
 
Net32RemoteCopy(sourcepath, destpath,
          sourcepass, destpass,
          openflags, copyflags,
          buf, ulBuflen);            /* 32 bit */

Parameters

See Common Parameter Definitions for descriptions of parameters not defined here.

sourcepath

(const unsigned char LSFAR *) points to an ASCIIZ string containing the path name of the files to be copied. Wildcards can be used. This parameter must begin with either a redirected drive or a UNC name.
destpath
(const unsigned char LSFAR *) points to an ASCIIZ string containing the path name to which sourcepath is to be copied. For a wildcard sourcepath, destpath must be a directory. This parameter must begin with either a redirected drive or a UNC name.
sourcepass
(const unsigned char LSFAR *) is reserved and must be NULL.
destpass
(const unsigned char LSFAR *) is reserved and must be NULL.
openflags
(16-bit unsigned short or 32-bit unsigned long) specifies how destpath will be opened. This parameter is defined as follows: ┌───────┬──────────────────────────────────────────────────────────────────────┐
│ BIT │ MEANING │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 0-1 │ Used if destpath exists. If 0, the open fails; if 1, the file is │
│ │ appended; and if 2, the file is overwritten. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 2-3 │ Reserved, with a value of 0. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 4 │ Used if destpath does not exist. If 0, the open fails; if 1, the │
│ │ file is created. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 5-15 │ Reserved, with a value of 0. │
└───────┴──────────────────────────────────────────────────────────────────────┘

copyflags
(16-bit unsigned short or 32-bit unsigned long) specifies how the file copy is done. This parameter is defined as follows: ┌───────┬──────────────────────────────────────────────────────────────────────┐
│ BIT │ MEANING │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 0 │ If 1, destpath must be a file. If bit 0 is set to 1, bit 1 must be │
│ │ 0. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 1 │ If 1, destpath must be a directory. If bit 1 is set to 1, bit 0 │
│ │ must be 0. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 2 │ If 0, destpath is opened in binary mode. If 1, destpath is opened │
│ │ in text mode. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 3 │ If 0, sourcepath is opened in binary mode. If 1, sourcepath is │
│ │ opened in text mode. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 4 │ If 1, all writes are verified. │
├───────┼──────────────────────────────────────────────────────────────────────┤
│ 5-15 │ Reserved. │
└───────┴──────────────────────────────────────────────────────────────────────┘

buf
(unsigned char LSFAR *) points to the copy_info data structure.
Return Codes

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) ┌─────────────────────────────┬───────┬────────────────────────────────────────┐│SYMBOLICCONSTANT │VALUE│MEANING │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_Success │ 0 │ No errors were encountered. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_FILE_NOT_FOUND │ 2 │ The file was not found. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_PATH_NOT_FOUND │ 3 │ The path was not found. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_ACCESS_DENIED │ 5 │ Administrator privilege is required. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_NO_MORE_FILES │ 18 │ No more files are available. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_SHARING_VIOLATION │ 32 │ A sharing violation occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_FILE_EXISTS │ 80 │ The file already exists. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_PARAMETER │ 87 │ At least one parameter value is not │
│ │ │ valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NetNotStarted │ 2102 │ The redirector NETWKSTA.200 has not │
│ │ │ been started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BufTooSmall │ 2123 │ The buffer is too small for fixed- │
│ │ │ length data. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_OS2IoctlError │ 2134 │ An internal error occurred when │
│ │ │ calling the workstation driver. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_WkstaNotStarted │ 2138 │ The Requester service has not been │
│ │ │ started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_SourceIsDir │2380 │Thesourcepathcannotbeadirectory .│
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadSource │ 2381 │ The source path is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadDest │ 2382 │ The destination path is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_DifferentServers │ 2383 │ The source and destination paths are │
│ │ │ on different servers. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosFsCtl
  
• DosDevIOCtl
Remarks

Currently, the source and destination for the file copy must be on the same server, or an error results. The following cases are valid:

• The source and destination are both files. The source file is copied to the destination file, subject to openflags and copyflags limitations.

• The source is either a file or wildcard, and the destination is a directory. The source files are copied to the destination directory, subject to openflags and copyflags limitations.
Related Information

For information about:

• Listing the shared resources of a server, see Share - NetShareEnum. 
  Moving remote files between servers, see Remote Utility - NetRemoteMove.
  
  Share passwords, see Share Category.

  ---

  [Back: NetRemoteTOD Data Structure]
  [Next: NetRemoteExec or Net32RemoteExec]