VS:SetCheckoutsComment

From Vectorworks Developer
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Set the comment that will be used for checkouts and commits.


The Enter Comment dialogs will still be shown when a checkout or commit is done; the dialog will be prepopulated with the comment set with this command.

FUNCTION SetCheckoutsComment(
comment :STRING) : BOOLEAN;
def vs.SetCheckoutsComment(comment):
    return BOOLEAN

Parameters

comment STRING The comment to replace any currently in use.

Return Value

True on success, false on failure or not Project Sharing file.

Version

Availability: from Vectorworks 2016

See Also

VS Functions:

VS:GetCheckoutsComment

VS Functions: [[VS:GetCheckoutsComment]]