Skip to content

Latest commit

 

History

History
57 lines (47 loc) · 1.49 KB

Rpstr_GetValueBool.md

File metadata and controls

57 lines (47 loc) · 1.49 KB

Rpstr_GetValueBool

Description

Get a boolean value from the VectorScript value repository.

FUNCTION Rpstr_GetValueBool(
				name         : STRING;
				defaultValue : BOOLEAN): BOOLEAN;
def vs.Rpstr_GetValueBool(name, defaultValue):
    return BOOLEAN

Parameters

Name Type Description
name STRING The name of the value.
defaultValue BOOLEAN Default value if the name does not exist in the VectorScript value repository.

Remarks

Here is a sample for when this is used from the SDK plugin to communicate with a dialog: bool CDlgXXX::CreateDialogLayout() { VectorWorks::Scripting::IVectorScriptEnginePtr vsEngine( VectorWorks::Scripting::IID_VectorScriptEngine ); if ( vsEngine ) { VWVariant varParamsList( true ); vsEngine->Repository_SetValue( "XXX_VarName", varParamsList ); }

return this->CreateDialogLayoutFromRsrcAndVWR( kDialogID, DefaultPluginVWRIdentifier() );

}

See Also

VS Functions: Rpstr_RemoveValues | Rpstr_RemoveValue | Rpstr_GetValueBool | Rpstr_SetValueBool | Rpstr_GetValueInt | Rpstr_SetValueInt | Rpstr_GetValueReal | Rpstr_SetValueReal | Rpstr_GetValueStr | Rpstr_SetValueStr

Version

Availability: from Vectorworks 2012

Category

  • Utility