Jump to content

wpclsQuerySetting

From EDM2
Revision as of 21:47, 25 May 2025 by Martini (talk | contribs) (Created page with "{{DISPLAYTITLE:wpclsQuerySetting}} This method returns the class object settings from the Settings notebook. ==Syntax== _wpclsQuerySetting(somSelf, pszSetting, pValue, ulValueLen) ==Parameters== ;'''somSelf''' (M_WPAbstract *) - input :Pointer to the WPAbstract class object. ;'''pszSetting''' (PSZ) - input :Name of the setting that is to be queried. ;'''pValue''' (PVOID) - in/out :Buffer in which settings values are returned. If this parameter is NULL, onl...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This method returns the class object settings from the Settings notebook.

Syntax

_wpclsQuerySetting(somSelf, pszSetting, pValue, ulValueLen)

Parameters

somSelf (M_WPAbstract *) - input
Pointer to the WPAbstract class object.
pszSetting (PSZ) - input
Name of the setting that is to be queried.
pValue (PVOID) - in/out
Buffer in which settings values are returned. If this parameter is NULL, only the length of the value of the setting is returned.
ulValueLen (ULONG) - input
Length of pValue.
ulReturnedData (ULONG) - returns
Length of data returned in pValue. A return value of 0 indicates an error occurred, in which case no data is returned in pValue.

Returns

ulReturnedData (ULONG) - returns
Length of data returned in pValue. A return value of 0 indicates an error occurred, in which case no data is returned in pValue.

Remarks

This is a virtual method and must be overridden by a subclass. Each subclass documents the possible values for pszSetting and pValue. These settings and values are specific for each subclass. Note that all settings have safe defaults, so it is never necessary to pass unnecessary settings to an object.

For a list of settings and their associated values, see the individual classes.

How to Override

This is a virtual method and must be overridden by a subclass.

Usage

This method should never be called. It is a virtual method and must be overridden by a subclass.

Related Methods