Gets the value of a string parameter and returns its value to the caller.

DWORD       lncGetParameterString(
  LPCSTR      szNode, 
  DWORD       dwSection,
  DWORD       dwParameter,
  LPSTR       pszVal,
  LPDWORD     pdwSize);

Parameters

szNode

(in) the name of the local node; ignored for a system parameter.

dwSection

(in) the section containing the parameter.

dwParameter

(in) the number of the parameter.

pszVal

(out) pointer to a memory area of at least the length passed in through pdwSize on entry.

pdwSize

(in/out) pointer to a DWORD that on entry contains the number of bytes available in the buffer. On successful exit, the value is changed to the number of bytes in the returned value including the terminating zero.

Return values

Zero for success or an error code on failure.

Remarks

If the size is not enough for the value, the error code LNCE_PARSIZE is returned and the DWORD pointed to by the pdwSize parameter is set to the number of bytes required to store the value.

Errors

LNCE_NOACCESS, LNCE_PARTYPE, LNCE_PARSIZE, LNCE_READERR, LNCE_SECTION_NFND, LNCE_PAR_NFND, LNCE_NODE_NFND

Requirements