NetConfigGetAll2 or Net32ConfigGetAll2

The NetConfigGetAll2 API retrieves all configuration information for a given network component in the IBMLAN.INI file of a local computer or a remote server.

The NetConfigGetAll2 API replaces the NetConfigGetAll API, which is now obsolete.

Restrictions

This API can be called from DLS and OS/2 workstations. (A local call on a DLS workstation retrieves information from the local NETWORK.INI file.) Administrative authority is required to call this API at a remote server.

#include <netcons.h>
#include <config.h>
NetConfigGetAll2(pszServername, reserved, component,
                 buf, usBuflen, pusBytesReturned,
                 pusBytesAvail);            /* 16 bit */
 
Net32ConfigGetAll2(pszServername, reserved, component,
                 buf, ulBuflen, pulBytesReturned,
                 pulBytesAvail);            /* 32 bit */

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

reserved

(const unsigned char LSFAR *) must be NULL.

component

(const unsigned char LSFAR *) points to an ASCIIZ string specifying the name of the component to search.

buf

(unsigned char LSFAR *) points to the memory address where the parameter values of a component are to be returned.

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_SHARING_VIOLATION Г 32 Г A sharing violation occurred. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_BAD_NETPATH Г 53 Г The network path cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_PARAMETER Г 87 Г At least one parameter value is not Г
Г Г Г valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_MORE_DATA Г 234 Г Additional data is available, but the Г
Г Г Г buffer is too small. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_NetNotStarted Г 2102 Г The redirector NETWKSTA.200 has not Г
Г Г Г been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BufTooSmall Г 2123 Г The buffer is too small for fixed- Г
Г Г Г length data. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InternalError Г 2140 Г An internal error has occurred. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BadTransactConfig Г 2141 Г The server is not configured for Г
Г Г Г transactions. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidAPI Г 2142 Г The requested API is not supported on Г
Г Г Г the remote server. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_CfgCompNotFound Г 2146 Г The program could not find the speci- Г
Г Г Г fied component in the IBMLAN.INI file. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidComputer Г 2351 Г The specified computer name is not Г
Г Г Г valid. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

Other codes could be returned from the following functions:

DosChgFilePtr
DosDuphandle
DosFsCtl
DosGetShrSeg
DosOpen
DosRead

NetConfigGetAll2 returns in buf a set of concatenated ASCIIZ strings that represent configuration information for the specified component. Each string is ended by NULL (ASCII 0), and the whole buffer is ended by a null string. Information is returned in the form parm=value. The parameter name, which appears to the left of the equals sign (=), is in uppercase. The pusBytesReturned and pusBytesAvail values are filled in as they are for GetInfo calls.

For example,

"  foo = Bar,1,long comment string "

in the IBMLAN.INI file is returned as:

"FOO=Bar,1,long comment string"

[Back]

[Next]