NetHandleSetInfo

The NetHandleSetInfo API sets handle-specific information.

Restrictions

A call to this API can be issued only from a requester and only to a remote LAN Server.

If the handle is not to a remote serial device or remote named pipe, the ERROR_INVALID_PARAMETER error code is returned. An OS/2 application can control handles to remote serial devices or remote named pipes. DOS LAN Services (DLS) can control only handles to remote named pipes.

This API is 16-bit only.

Syntax

#include <netcons.h>
#include <chardev.h>
 
NetHandleSetInfo(handle, sLevel, buf,
                 usBuflen, parmnum);     /* 16 bit */

Parameters

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

handle

(unsigned short) is the handle identification number for the communication device, queue, or named pipe that is to be queried.
sLevel
(short) must be 1, which specifies the data structure described in Handle Level 1.
parmnum
(unsigned short) specifies whether the entire data structure or only a single field in the data structure is to be passed. If the value is 0, the entire data structure is passed. As defined in the CHARDEV.H header file, parmnum can be set as follows to pass only a single field: ┌───────────────────────────┬────────────┬─────────────────────────────────────┐
│ SYMBOLIC CONSTANT │ VALUE │ COMPONENT │
├───────────────────────────┼────────────┼─────────────────────────────────────┤
│ HANDLE_SET_CHAR_TIME │ 1 │ hdli1_chartime │
├───────────────────────────┼────────────┼─────────────────────────────────────┤
│ HANDLE_SET_CHAR_COUNT │ 2 │ hdli1_charcount │
└───────────────────────────┴────────────┴─────────────────────────────────────┘

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_ACCESS_DENIED │ 5 │ Administrator privilege is required. │
├───────────────────────────┼───────┼──────────────────────────────────────────┤
│ ERROR_INVALID_PARAMETER │ 87 │ At least one parameter value is not │
│ │ │ valid. │
├───────────────────────────┼───────┼──────────────────────────────────────────┤
│ ERROR_INVALID_LEVEL │ 124 │ The sLevel parameter 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_WkstaNotStarted │ 2138 │ The Requester service has not been │
│ │ │ started. │
├───────────────────────────┼───────┼──────────────────────────────────────────┤
│ NERR_InternalError │ 2140 │ An internal error has occurred. │
├───────────────────────────┼───────┼──────────────────────────────────────────┤
│ NERR_BadTransactConfig │ 2141 │ The server is not configured for trans- │
│ │ │ actions. │
├───────────────────────────┼───────┼──────────────────────────────────────────┤
│ NERR_InvalidComputer │ 2351 │ The specified computer name is not │
│ │ │ valid. │
└───────────────────────────┴───────┴──────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosDevIOCtl
  
• DosFsCtl
  
• DosGetShrSeg
  
• DosSemClear

---

[Back: NetHandleGetInfo]
[Next: 386-HPFS Information and Administration Category]