Previous Medical Imaging in IDL: IDL DICOM Reference Next

IDLffDicomExCfg::StorageScpService

Syntax | Return Value | Arguments | Keywords | Version History

The IDLffDicomExCfg::StorageScpService function method is used to start, stop or check the status of the local IDL Storage SCP service.

The local IDL Storage SCP service is a process that listens at a specified port for incoming DICOM files and writes the files to disk. On Microsoft Windows systems, the local IDL Storage SCP service is a Windows service. On UNIX systems, the local IDL Storage SCP service is a regular process. See About the Storage SCP Service for additional information.

Syntax

Result = Obj->[IDLffDicomExCfg::]StorageScpService(Command)

Return Value

The return value is a string indicating the status of the Storage SCP service command specified by Command. The specific string issued depends on the type of system (Windows or UNIX), the Command specified (Start, Stop, or Status), and the state of the Storage SCP service.

Possible return values for the Start command:

Table 3-23: Return Values for the Start Command 

Table 3-23: Return Values for the Start Command 
Windows
UNIX
start request issued  
start request issued
service already running  
service already running
start access denied  
 
service logon failed  
 
service is disabled  
 
path not found  
 
start request failed  
start failed
failed. administrator privileges 
maybe needed.  
 
failed, is IDL DicomEx Storage 
SCP service installed?  
 

Possible return values for the Stop command:

Table 3-24: Return Values for the Stop Command 

Table 3-24: Return Values for the Stop Command 
Windows
UNIX
stop request issued  
stop request issued
service stopped  
 
service not running  
service not running
stop access denied  
 
stop request failed  
 
 
failed to send shutdown messages
failed. administrator privileges 
maybe needed.  
 
failed, is IDL DicomEx Storage 
SCP service installed?  
 

Possible return values for the Status command:

Table 3-25: Return Values for the Status Command 

Table 3-25: Return Values for the Status Command 
Windows
UNIX
service running  
service running  
service not running  
service not running  
query access denied  
 
query status failed  
 
service does not exist  
 
service start pending  
 
service stop pending  
 
service pause pending  
 
service paused  
 
service status unknown  
 
failed. administrator privileges 
maybe needed.  
 
failed, is IDL DicomEx Storage 
SCP service installed?  
 

Arguments

Command

One of the following strings:

Command
Meaning
Start  
Attempt to start the local IDL Storage SCP service if it is not already running.
Stop  
Attempt to stop the local IDL Storage SCP service if it is running.
Status  
Attempt to determine the state of the local IDL Storage SCP service (running or not running).

Keywords

None

Version History

6.3
Introduced

  IDL Online Help (March 06, 2007)