ILTDicRd Interface

This is the interface for the LEAD DICOM Reader.

Interface Properties

***HRESULT put_InputFileName(const OLECHAR *pszFileName)***

Parameters

pzFileName

Pointer to an OLECHAR string that contains the input DICOM file

Description

Sets the input file name. Should you set the InputFileName to NULL, be sure to set an input dataset using SetDicomDS because otherwise you will have no input data and the filter will fail to connect. The function fails under the following conditions:

If the filter output pin is already connected.
If a user dataset is initialized.
If the input file contains no pixel data.
If the input file is not a valid DICOM file.
If the length of the input file name exceeds the maximum length allowed for a file name (260 characters)

The default value is "". Note that the DICOM file may contain MPEG2 data, which would require that a MPEG-2 video decoder Also known as a decompressor Also known as a decoder, this is a module or algorithm to decompress data., this is a module or algorithm to decompress data. be installed before the file could be played.

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT get_InputFileName(OLECHAR **ppszFileName)

Parameters

ppszFileName

Address of a pointer to the returned DICOM input file name.

Description

Retrieves the input file name. This function allocates memory for the string. You are responsible for freeing the memory by using SysFreeString().

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT get_ConnectionState(int * pbConnected)

Parameters

pbConnected	Pointer to a variable that will receive the connection state of the output pin. Possible values are:
	Value	Meaning
	TRUE	The output pin is connected.
	FALSE	The output pin is not connected.

Description

Gets a value that indicates whether the output pin is connected.

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT get_DicomDS(long * pDS)

Parameters

pDS	Address of a pointer to the returned dataset.

Description

Retrieves the currently initialized DICOM dataset. Typecast this pointer to LDicomDS before using it. Do not make changes to the dataset after the filter is connected, since this might cause problems with the LEAD DICOM Reader.

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT put_FrameTime(long lFrameTime)

Parameters

lFrameTime

New frame time value in milliseconds.

Description

Sets the frame time (the time each frame is displayed while playing the PixelData), in milliseconds. Possible values range between 20 and 1000. The Frame Control feature must be enabled in order to control the frame time (and thus the play speed). If frame time is not enabled, the stream plays with the frame time set to 40 milliseconds (25 frames per second).

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT get_FrameTime(long * lFrameTime)

Parameters

lFrameTime

Pointer to a variable that will receive the current frame time.

Description

Retrieves the frame time (the time each frame is displayed while playing the PixelData), in milliseconds. The default value is 40.

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT put_FrameControl(int bEnableFrameControl)

Parameters

bEnableFrameControl	A Boolean value that enables or disables frame control. Possible values are:
	Value	Meaning
	TRUE	Enable frame control.
	FALSE	Disable frame control.

Description

Sets the frame control using put_FrameTime or set through the interface by using the property page.

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT get_FrameControl(int *bEnableFrameControl)

Parameters

bEnableFrameControl	Pointer to a variable that indicates whether frame control is enabled. Possible values are:
	Value	Meaning
	TRUE	Frame control is enabled.
	FALSE	Frame control is disabled.

Description

Retrieves a value that indicates whether frame control is enabled. The default values is FALSE.

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT put_FrameDropping(int EnableFrameDropping)

Parameters

bEnableFrameDropping	A Boolean variable that contains a value that indicates whether frames can be dropped. Possible values are:
	Value	Meaning
	TRUE	Frames can be dropped.
	FALSE	Keep every frame.

Description

Use this function to set the filter to drop frames when necessary in order to maintain the frame rate. To enable frame dropping set bEnableFrameDropping to TRUE. To keep every frame set bEnableFrameDropping to FALSE.

Returns

Always returns S_OK.

HRESULT get_FrameDropping(int *pbEnableFrameDropping)

Parameters

pbEnableFrameDropping	pointer to a Boolean value that indicates whether the frame dropping feature is currently set to drop frames.
	Value	Meaning
	TRUE	The filter is currently set to drop frames when necessary to maintain the frame time.
	FALSE	The filter is set to keep every frame.

Description

Gets a value that indicates whether the filter is currently set to drop frames when necessary to maintain the frame time. The default value is FALSE.

Returns

S_OK	SUCCESS
E_INVALIDARG	The input pointer is invalid.

Interface Methods

HRESULT SetDicomDS(long pDS, int bCopy)

Parameters

pDS	Pointer to the user dataset.
bCopy	A value that specifies whether the filter should make a copy of the passed dataset for future usage. Possible values are:
	Value	Meaning
	TRUE	Make a copy of the dataset (allocating memory for it, and maintaining responsibility for freeing this memory).
	FALSE	The user will take care of the pointer life (and ensure its availability for the Writer as long as it is needed).

Description

Sets the DICOM dataset inside the LEAD DICOM Reader filter. Before using this function you need to first create and initialize a dataset using the raster toolkit and LDicomDS::InitDS and either LDicomDS::LoadDS or LDicomDS::LoadDSMemory. This function fails:

If the LEAD DICOM Reader is already connected
If the dataset contains no pixel data
If the pixel data could not be read properly.

Call this method with pDS set to NULL:

To stop the LEAD DICOM Reader from using the dataset
Before freeing the dataset's memory.

Returns

S_OK	SUCCESS
< 0	An error occurred.

HRESULT ResetToDefaults()

Description

Resets the LEAD DICOM Reader option values to the default values, as follows:

InputFileName = ""
FrameControl = FALSE
FrameDropping = FALSE
FrameTime = 40

Returns

Always returns S_OK.