Inheritance diagram for IParameter:
All parameters should first be retrieved using the IParameterDatabase::FindParameter method, or using the IParameterDatabase::Parameters collection. This will set all information of the parameter object. Next the parameter can be changed through this interface. Writing back the changes to the reader should be done with the Save method.
For details about the parameter information, see method and property details.
Note that:
Public Member Functions | |
HRESULT | ParameterDatabase ([out, retval] IParameterDatabase **ppintfParameterDatabase) |
Returns the parameter database this parameter belongs to. | |
HRESULT | Number ([out, retval] ENVP *pENVP) |
Returns the number of the parameter. | |
HRESULT | Description ([out, retval] BSTR *pbstrDescription) |
Returns a description of this parameter (only if a correct language dll can be found). | |
HRESULT | GetDescription ([in, defaultvalue(1)] VARIANT_BOOL LongDescription,[out, retval] BSTR *pbstrDescription) |
Returns a long or short description of this parameter. | |
HRESULT | Value ([out, retval] VARIANT *pvtValue) |
Returns the current value of this parameter. | |
HRESULT | Value ([in] VARIANT NewValue) |
Sets the new value of this parameter. | |
HRESULT | ValueDescription ([out, retval] BSTR *pbstrDescription) |
Returns a description of the current value of this parameter (in readable format). | |
HRESULT | Type ([out, retval] ENVPType *peType) |
Returns the type of the parameter. | |
HRESULT | Size ([out, retval] short *psSize) |
Returns the size of this parameter value. | |
HRESULT | Min ([out, retval] VARIANT *pvtMin) |
Returns the minimum value of this parameter. | |
HRESULT | Max ([out, retval] VARIANT *pvtMax) |
Returns the maximum value of this parameter. | |
HRESULT | Default ([out, retval] VARIANT *pvtDefault) |
Returns the default factory setting of this parameter. | |
HRESULT | IsReadOnly ([out, retval] VARIANT_BOOL *pfIsReadOnly) |
Returns true if this parameter is a read-only parameter. | |
HRESULT | IsPassword ([out, retval] VARIANT_BOOL *pfIsPassword) |
Returns true if this parameter is a password parameter. | |
HRESULT | IsModified ([out, retval] VARIANT_BOOL *pfIsModified) |
Returns true if the value of this parameter is modified. | |
HRESULT | CanBeChangedByUser ([out, retval] VARIANT_BOOL *pfIsUserLevel) |
Returns true if this parameter is accessable at user level. | |
HRESULT | CanBeChangedByInstaller ([out, retval] VARIANT_BOOL *pfIsInstaller) |
Returns true if this parameter is accessable at installer level. | |
HRESULT | IsResetRequired ([out, retval] VARIANT_BOOL *pfIsResetRequired) |
Returns true if this parameter requires a restart to be effective after it has been changed. | |
HRESULT | AdditionalInfoPresent ([out, retval] VARIANT_BOOL *pfIsAdditionalInfo) |
Returns true if this parameter contains additional information (min/max and default information). | |
HRESULT | Save ([in, defaultvalue(0xffff)] VARIANT_BOOL fDisableRFID,[out, retval] VARIANT_BOOL *pfSucceeded) |
Save the new parameter settings into the reader. | |
HRESULT | Refresh () |
Refresh this parameters value. |
|
Returns the parameter database this parameter belongs to.
|
|
Returns the number of the parameter.
|
|
Returns a description of this parameter (only if a correct language dll can be found). This property will receive the long description of this parameter. See GetDescription for more information.
|
|
Returns a long or short description of this parameter. If this parameter is for instance nvpDoorOpenTime, the long english description will return: "Door open time, in seconds", the short description will be "Open time". The description is loaded from a resource dll (only if the correct language dll can be found). Note that when for instance a Dutch windows version is installed, a dutch description will be returned.
|
|
Returns the current value of this parameter. This property may return three different type:
|
|
Sets the new value of this parameter. If the parameter contains AdditionalInfoPresent, Min and Max can be used to determine the boundaries of this parameter. The Default property holds the factory default value for this parameter.
|
|
Returns a description of the current value of this parameter (in readable format). If this parameter is for instance nvpTimezoneWeekscheme, and the value is for instance 7, the english description will return the string: "Monday, Tuesday, Wednesday" (or something similar). The description is loaded from a resource dll (only if the correct language dll can be found). Note that when for instance a Dutch windows version is installed, a dutch description will be returned. If this parameter contains a password (see IsPassword), the following string will always be returned: "*********".
|
|
Returns the type of the parameter.
|
|
Returns the size of this parameter value. For number parameters, this property returns the size in bytes of the number (1 for a BYTE, 2 for a WORD, 4 for a DWORD). For a string parameter, this property returns the number of characters in the string (string length).
|
|
Returns the minimum value of this parameter. This property only contains a valid value if AdditionalInfoPresent is true and this is a ntUnsignedNumber parameter type (see Type), else it will returns the absolute minimum value of the value (which depends on the Size of the parameter).
|
|
Returns the maximum value of this parameter. This property only contains a valid value if AdditionalInfoPresent is true and this is a ntUnsignedNumber parameter type (see Type), else it will returns the absolute maximum value of the value (which depends on the Size of the parameter).
|
|
Returns the default factory setting of this parameter. This property only contains a valid value if AdditionalInfoPresent is true and this is a ntUnsignedNumber parameter type (see Type), else it will returns the current value of this parameter.
|
|
Returns true if this parameter is a read-only parameter. If a parameter is read-only, the Save method can not be called for this parameter.
|
|
Returns true if this parameter is a password parameter. If this parameter contains a password, the Value should not be shown in any UI since showing it will compromize security. If this is a password, display stars ("****") or something similar instead of the real value.
|
|
Returns true if the value of this parameter is modified. If a parameter value has not been modified, Save has no effect.
|
|
Returns true if this parameter is accessable at user level. The current user level can be determined by passing "ReaderLevel" to the IProximityReader::GetProperty method.
|
|
Returns true if this parameter is accessable at installer level. The current user level can be determined by passing "ReaderLevel" to the IProximityReader::GetProperty method.
|
|
Returns true if this parameter requires a restart to be effective after it has been changed. When this property is true, and this parameter is changed, the IProximityReader::Reset method should be called after saving this parameter (or after saving a number of parameters at once) to activate the changes.
|
|
Returns true if this parameter contains additional information (min/max and default information). If this property returns true, the Min, Max and Default value contain valid data.
|
|
Save the new parameter settings into the reader. Some parameters will require a reset after they have been changed to activate the changes. If this parameter's property IsResetRequired is set, a reset should be executed to apply the changes (use IProximityReader::Reset). The value will not be saved when this is a read-only parameter (check the IsReadOnly property). The value will also not be saved if it has not been changed (check the IsModified property). If a user or installer is capable to change a parameter, depends on the reader configuration, user levels etc. Check the CanBeChangedByUser and CanBeChangedByInstaller properties to see if modification is possible at certain user levels. When saving a lot of parameters after each other, it is faster to disable the RFID interface before saving the first parameter, and re-enable it after the last user has been saved (and setting the fDisableRFID flag to false in this method). See IProximityReader::EnableRFID. The same applies to the reset, check each parameter if the reader should be reset to activate the parameter changes. If one or more parameters require a reset, it can be faster to perform the reset only once after changing all parameters. When saving a parameter, the IParameterDatabase will fire an OnProcessInfo event, with processtype ptParameterdatabaseChange and sub process type sptItemModified. The changed parameter will be passed to the OnProcessInfo event in the Info parameter.
|
|
Refresh this parameters value. Refresh the value of this parameter by requesting the latest value from the reader.
|