GetDocumentData

Returns a user data item from the current document.

Syntax

rhinoscriptsyntax.GetDocumentData (section=None, entry=None)

rhinoscript.userdata.GetDocumentData (section=None, entry=None)

Parameters

section

Optional.  String.  The section name.  If omitted, all section names are returned.

entry

Optional.  String.  The entry name.  If omitted, all entry names for section are returned.

Returns

List

A zero-based, one-dimensional array of all section names if section is not specified.

List

A zero-based, one-dimensional array of all entry names for section if entry is not specified.

String

The value of the entry if both section and entry are specified.

None

If not successful, or on error.

Example

import rhinoscriptsyntax as rs

value = rs.GetDocumentData("MySection1", "MyEntry1")

print value

 

value = rs.GetDocumentData("MySection1", "MyEntry2")

print value

 

value = rs.GetDocumentData("MySection2", "MyEntry1")

print value

Also See

DeleteDocumentData

DocumentDataCount

IsDocumentData

SetDocumentData