swirl
Guide to OmniMark 7   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
      Other Library Functions  
function  

dctm.result

 
 

Library: Interfaces, Documentum interface (OMDOCUMENTUM)
Import: omdocumentum.xmd
Return type: String
Returns: 

The string value that is returned by executing the specified command.


Declaration

  export external stream function result
       of          value stream command

Argument definitions

command
A string representation of the Documentum Content Server API command to be executed, along with all the arguments that must be specified for it.


Purpose

You can use the dctm.result function to call any Documentum Content Server API command which returns a value. This function corresponds to the Documentum Client Library (DMCL) function dmAPIGet. The applicable commands are documented in the Documentum Content Server API Reference Guide.

Example

This example connects to a Docbase and outputs an error message if failure occurs.

  import "omdocumentum.xmd" prefixed by dctm.

  process
     local stream docbase      initial {"sample-docbase"}
     local stream user         initial {"sample-user"}
     local stream password     initial {"sample-password"}

  process
     local stream docbase  initial {"conn_test_01"}
     local stream user     initial {"conn_test_01"}
     local stream password initial {"1conn_test1"}
     local stream session

     set session to dctm.result of
             "connect,%g(docbase),%g(user),%g(password)"

     do when session = ""
       output "Error connecting to the docbase%n"
       output "Error returned: "
         || dctm.result of "getmessage,current"
         || "%n"
     else
       output "Connected%n"
     done

Exceptions

The following exception can occur when calling this function:

        Other Library Functions
   dcmt.writer
   dctm.execute
   dctm.omdocumentum-version
   dctm.reader
   dctm.result
   dctm.set
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]

OmniMark 7.1.2 Documentation Generated: June 28, 2005 at 5:45:08 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © Stilo Corporation, 1988-2005.