VCOM:VectorWorks:ISDK::GetSavedSetting: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
URuntemund (talk | contribs) No edit summary |
||
| Line 23: | Line 23: | ||
<lineList ident=1> | <lineList ident=1> | ||
<line> | <line> | ||
const TXString& | |||
category | category | ||
A category name for the setting to be stored. | |||
</line> | </line> | ||
<line> | <line> | ||
const TXString& | |||
setting | setting | ||
The name of the setting to be stored. | |||
</line> | </line> | ||
<line> | <line> | ||
const TXString& | |||
value | value | ||
The value of the setting to be stored. | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
| Line 43: | Line 43: | ||
<return> | <return> | ||
On error returns: false</return> | On error returns: false</return> | ||
----------------------------------------------------------------------------------------------------------- | |||
<remark> | |||
The values are stored in an XML file. A "/" in "category" can be used as a hierarchy separator to store values in a structured way. | |||
</remark> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
| Line 54: | Line 61: | ||
[[Category:VCOM:VectorWorks:ISDK|GetSavedSetting]] | [[Category:VCOM:VectorWorks:ISDK|GetSavedSetting]] | ||
[[Category:VCOM:VectorWorks:ISDK(Utility)|GetSavedSetting]] | [[Category:VCOM:VectorWorks:ISDK(Utility)|GetSavedSetting]] | ||
== See also == | |||
[[VCOM:VectorWorks:ISDK::SetSavedSetting|SetSavedSetting]] | |||
Latest revision as of 14:49, 5 December 2018
.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference
Description
namespace VectorWorks
Member of VCOM:VectorWorks:ISDK
Read a value from the saved settings file.
virtual bool GetSavedSetting(
const TXString& category,
const TXString& setting,
const TXString& value)
Parameters
const TXString& category A category name for the setting to be stored. const TXString& setting The name of the setting to be stored. const TXString& value The value of the setting to be stored.
Return Value
Remarks
The values are stored in an XML file. A "/" in "category" can be used as a hierarchy separator to store values in a structured way.
Version
Availability: from Vectorworks 2009