This method should be used on a workspace enabled encyclopedia. When a session is established on the server, a workspace enabled encyclopedia must be open. The GetWorkspaceTree method requires a SessionId and a SAWSEncy object. GetWorkspaceTree method will return list of workspaces for a workspace enabled encyclopedia.
The SAWSResult objects sOutput member will contain the XML encoded workspace tree for the requested encyclopedia.
SAWSENCY_TYPE
SAWSENCY_SQL
SAWSENCY_ORA
SAWSEncy
eType as SAWSENCY_TYPE sServerName as string sEncyName as string
Values updated
The following SessionState value is checked before getting the workspace list:
State = SAEncyopen
Arguments
sSessionId
The session id returned from the startsession method
SAWSEncy
eType
Specify one of the encyclopedia types defined in the SAWSENCY_TYPE enumeration.
sServerName
Provide the name of the database server
sEncyName
Provide the name of the encyclopedia
Return
SAWSResult:
iError
0 if successful, otherwise an error number
sErrorMsg
Empty if successful, otherwise a description of the problem
sOutput
If successful the string will contain the XML encoded workspace tree for the passed encyclopedia, otherwise the string will be empty for an non workspace enabled encyclopedia.