Gets the details of a parameter.

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


DWORD       lncGetParameterInfo(
  DWORD           dwSection,
  DWORD           dwParameter,
  PLNC_PARINFO    pParInfo);

Parameters

dwSection

(in) the section containing the parameter.

dwParameter

(in) the number of the parameter.

pParInfo

(out) pointer to a structure that receives the details of the parameter. The structure members have the following meaning:

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 if 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_NOACCESS, LNCE_READERR, LNCE_PAR_NFND, LNCE_SECTION_NFND, LNCE_NODE_NFND

Requirements