Python API: sam v8_1_5
sam.getNextFile()

Just having some fun...
This is the python interface to the command 'sam get next file'.
Command Description:

Receive the next file to be analyzed. The full path to the file is returned.

If there are no more files to be processed, the string 'END OF STREAM' will be returned
to the caller.  (This may be referenced by means of the constant 
SAMStation.GPM2Consumer.end_of_stream).



Python Usage:
	from Sam import sam
	result = sam.getNextFile(...)

Return value: next file (string)

Arguments are passed as keyword-value pairs, as in:
	 myfunc(arg1='myarg', arg2='anotherarg', d=1)

Argument Keyword Description:
	(*) indicates that this keyword is required
	>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
    KEYWORD                    DATA TYPE            DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
    c                          SamBoolean           automatically close all servants after each method call
    corbaCallTimeout           int                  time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
    d                          SamBoolean           debug mode
    erralertflag               string               set to "verbose" for more information in output message
    minimalOutput              SamBoolean           Write unadorned output (useful for scripting)
    pollinterval               long                 number of seconds to wait before retrying getNextFile again
(*) processId                  long                 Consumer process ID for the process receiving the file
(*) project                    string               name of the project under which this process is running
    retryInterval              int                  retry interval base in seconds; will multiply this base times retryCount (default: 5)
    retryJitter                int                  retry jitter, random jitter added to base retry interval times retryCount (default: 5)
    retryMaxCount              int                  number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
    rtfile                     string               routing file into which results will be written
    s                          SamBoolean           retrySilently mode (do not issue messages to stderr on proxy retries)
(*) station                    string               name of the station where the project is running
    t                          SamBoolean           time-it mode (print additional info on timings)
    timeout                    long                 number of seconds to wait before timing out
    v                          SamBoolean           verbose mode
====================================================================================================================================

Environment Defaults:
	c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
	corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
	project = os.environ['SAM_PROJECT']
	retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
	retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
	retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
	s = os.environ['SAM_PYAPI_RETRY_SILENTLY']
	station = os.environ['SAM_STATION']



See Also: