MODALIZER SDK  3.2.2.2
IDCXAPP Interface Reference

Do not use this interface while other threads may be using the toolkit functionality. More...

Inherits IDispatch.

Public Member Functions

HRESULT StartLogging ([in] BSTR filename)
 Start logging to a file.
 
HRESULT StopLogging ()
 Stop logging.
 
HRESULT WriteToLog ([in] LOG_LEVEL logLevel, [in] BSTR message)
 
HRESULT FlushLog ()
 Explicit flash of the log memory buffer to the log file.
 
HRESULT CreateDCXOBJ ([out, retval] IDCXOBJ **e)
 Create a DCXOBJ. More...
 
HRESULT CreateDCXELM ([out, retval] IDCXELM **e)
 Create a DCXELM. More...
 
HRESULT CreateDCXOBJIterator ([out, retval] IDCXOBJIterator **e)
 Create a DCXOBJIterator. More...
 

Properties

pVal ConnectionTimeout [get]
 Set/Get global connection timeout. More...
 
NEW_INSTANCE_CREATION_POLICY NewInstanceUIDPolicy [set]
 Set the way SOP Instance UID's are created upon compression and decompression of images.
 
LOG_LEVEL LogLevel [get, set]
 Set/Get Log Level.
 
int MaxLogMessages [get, set]
 Set/Get maximum number of log messages per log file. More...
 
VARIANT_BOOL EnableInMemoryStorageSCP [get, set]
 Enable storage of received DICOM objects in memory.
 
BSTR Version [get]
 
BSTR ProjectVersion [get]
 
IStream LogStream [set]
 

Detailed Description

Do not use this interface while other threads may be using the toolkit functionality.

Use this interface to set the application setup propperties.

This interface provides methods to set the propperties of the the application such as logging file.

Member Function Documentation

◆ CreateDCXELM()

HRESULT IDCXAPP::CreateDCXELM ( [out, retval] IDCXELM **  e)

Create a DCXELM.

This call is identical to new IDCXELM(). It becomes handy in frameworks like Qt

◆ CreateDCXOBJ()

HRESULT IDCXAPP::CreateDCXOBJ ( [out, retval] IDCXOBJ **  e)

Create a DCXOBJ.

This call is identical to new IDCXOBJ(). It becomes handy in frameworks like Qt

◆ CreateDCXOBJIterator()

HRESULT IDCXAPP::CreateDCXOBJIterator ( [out, retval] IDCXOBJIterator **  e)

Create a DCXOBJIterator.

This call is identical to new IDCXOBJIterator(). It becomes handy in frameworks like Qt

◆ WriteToLog()

HRESULT IDCXAPP::WriteToLog ( [in] LOG_LEVEL  logLevel,
[in] BSTR  message 
)

Write user's message text to log This is useful for marking specific positions in the DICOM log or to use it for logging of the application

Property Documentation

◆ ConnectionTimeout

pVal IDCXAPP::ConnectionTimeout
getproperty

Set/Get global connection timeout.

The connection timeout is the time that the socket layer will wait when trying to connect to a remote system. The default value is 15 seconds.

◆ LogStream

IStream IDCXAPP::LogStream
setproperty

Sets an output stream that is used to write log to This takes over log file if was set by StartLogging.

◆ ProjectVersion

BSTR IDCXAPP::ProjectVersion
get
Returns
MODALIZER SDK Project Version

◆ Version

BSTR IDCXAPP::Version
getproperty

Use this method to verify the SDK version being used

Returns
MODALIZER SDK Version Number RZVERSIONCPP SC_PROJECTVERSION
MODALIZER SDK Version Number