VS:SetDefStoryLayerName: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
(No difference)
|
Latest revision as of 14:37, 12 August 2013
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Sets the name of the nth Default Story Layer in the file. For example, if 3 is passed in, it will set the name of the 3rd Default Story Layer in the file.
FUNCTION SetDefStoryLayerName(
index :INTEGER;
name :STRING) : BOOLEAN;
def vs.SetDefStoryLayerName(index, name): return BOOLEAN
Parameters
index INTEGER The index of the default story layer whose name should be set. name STRING The name that the indicated default story layer should be set to.
Return Value
Whether the setting of the name of the default story layer succeeded. It will fail if passed an invalid index. The name must not have more than 63 characters and must not be used by another default story layer in the file.
Example
VAR result : BOOLEAN; BEGIN result := SetStoryLayerTemplateName(2, "Subfloor");
Version
Availability: from Vectorworks 2013
See Also
VS Functions:
VS:GetNumStoryLayerTemplates | VS:GetStoryLayerTemplateName
VS Functions:
[[VS:GetNumStoryLayerTemplates]]
| [[VS:GetStoryLayerTemplateName]]