Gets the details of a system parameter.

typedef struct { 
    DWORD dwSize; 
    DWORD dwType; 
    LPCTSTR szShort; 
    LPCTSTR szLong; 
} LNC_PARINFO, *PLNC_PARINFO;

DWORD lncSysGetParInfo(
    DWORD dwPar, 
    PLNC_PARINFO pParInfo);

Parameters

dwPar

(in) the number of the parameter (see parameter values).

pParInfo

(out) pointer to a LNC_PARINFO structure that receives the details of the parameter.

Structure members

The LNC_PARINFO structure members have the following meanings:

dwSize

(in) the size of the structure in bytes; must be set before calling lncGetParameterInfo.

dwType

(out) REG_DWORD, REG_SZ or REG_MULTI_SZ

szShort

(out) a short name for the parameter

szLong

(out)a longer description for the parameter

Return values

Zero for success or an error code on failure.

Remarks

The first time this function is called for a given parameter space is allocated for a short and long name in ASCII or Unicode (depending on the character use of the caller). This space is released at process end or when calling lncFreeAllStrings.

Errors

LNCE_PAR_NFND

the parameter number is invalid

Requirements