Email this Page Log Support Call Send Feedback Print

Previous Topic

Next Topic

Book Contents

Book Index

GetObject(LogonID, ObjectID, LockObject)

Returns an Author-it Object as XML. The object must exist in the library. If the object does not exist, an error will be returned.

This function is the recommended starting point for programmatically modifying an object.

Parameter

Type

Explanation

LogonID

String

ID returned from LogOn function.

ObjectID

Integer

The Object Key of the object to be returned

LockObject

Boolean

Whether to lock the object or not

Return

String

Object as XML, or error message.

The following error messages may be returned:

Error - Not currently logged on

Error: Object [123] does not exist

Error: User [username] does not have permission to view Object [123]

Error: Cannot lock object:[123]

Error - XML could not be created

See Also

Object Functions

Search(Code, Description, BasedOn, ObjectType, FromDate, ToDate, ContainingText, InBook, ReleaseState

SearchPageByIndex(LogonID, Code, Description, BasedOn, ObjectType, FromDate, ToDate, ContainingText, InBook, ReleaseState, FolderId, IsTemplate, ResolveDependancies, ReturnAsObjectBases, SortBy, SortAsc, StartIndex, PageSize, ResultsLimit)

GetNewObject(LogonID, ObjectType, BasedOn)

GetObjects(LogonID, XMLSummarys, LockObjects)

GetObjectsBrief(LogonID, XMLSummarys, LockObjects)

GetObjectsInFolder(LogonID, FolderID)

SetObjects(LogonID, XML, Unlock)

IsObjectLocked(LogonID, ObjectID)

UnlockObject(LogonID, ObjectID)

UnlockObjects(LogonID)

Top of Page Email this Page Log Support Call Send Feedback Print