Terason 2000 Ultrasound COM Automation Interface

This is used for controlling the Terason 2000 Ultrasound system via COM automation. Once the Ultrasound.exe program has been run the first time, the COM automation interface is fully registered and ready to go. The interface name (or ProgID) is "Ultrasound.Document".

The application's Document object provides the automation dispatch interface. Visual Basic developers will want to look at the desciption of interface IDocumentDisp. Visual C++ users will want to look at the class description CUltrasoundDoc. The same information is documented in the interface and class definitions. One format is more natural to view for Visual Basic developers and one is more natural to view for Visual C++ developers.

The COM Automation interface makes it simple to integrate the Terason 2000 with external applications. To illustrate, here is an example of the minimum code required to begin Imaging with the Terason 2000 Ultrasound system.

Example

Creating the dispatch object in Visual Basic:

Dim objTT2000 As Object
Set objTT2000 = CreateObject("Ultrasound.Document")
objTT2000.InitTT2000
Creating the dispatch object in Visual C++:

IDocumentDisp m_tt2000Object;   // our TT2000 dispatch object
m_tt2000Object.CreateDispatch(_T("Ultrasound.Document"));
m_tt2000Object.InitTT2000();
A note about error handling: All of the Dispatch methods will throw a COleDispatchException object to indicate an error condition. For Visual Basic users this means that you should check the 'Err' object after any dispatch calls are made. For Visual C++ users this means that you should wrap all dispatch calls with appropriate TRY CATCH blocks. (see examples in the Overview section)

Copyright © 2000 Terason Division of Teratech Corp.
All rights reserved. This document built on 06/04/02.


Interfaces

  • IDocumentDisp
  • IPatientInfo
  • IStudyInfo


  • Classes

  • CPatientInfo
  • CStudyInfo
  • CUltrasoundDoc


  • Overviews

    Examples showing how to use the automation interface from Visual Basic and also from Visual C++.

    Since these are simple examples, there is only error handling on the first call to InitTT2000. This is done to illustrate a method of handling the COM automation exceptions which are thrown by the Terason 2000. It is strongly recommended that ALL automation calls be handled appropriately according to your given requirements.

    Example

    Visual Basic:

    ' declare an Object for our TT2000 automation object
    Dim objTT2000 As Object
    On Error Resume Next
    Set objTT2000 = CreateObject("Ultrasound.Document")
    If Err.Number <> 0 Then
        sMsg = MessageText(Err.Number)
        MsgBox "Automation Error " & vbCr & Err.Number & _
    	" (" & Hex(Err.Number) & ")" & vbCr & sMsg
        ' Should bail no further use of objTT2000 will be valid.
    End If
    ' obviously we should not continue since we had the previous error
    ' this is just an example
    objTT2000.InitTT2000
    objTT2000.ShowWindow 0,-1,-1,-1,-1,1  ' hide the window (no other window changes)
    
         ' show the window on top, at 10,20 with a size of 600x400
         objTT2000.ShowWindow 2,10,20,600,400,0
    
    Visual C++:

    IDocumentDisp m_tt2000Object;   // our TT2000 dispatch object
    // Note: IDocumentDisp is a class created by the Visual Studio
    // class wizard by importing the TT2000.tlb type library.
    
    // create our dispatch object.
    if (!m_tt2000Object.CreateDispatch(_T("Ultrasound.Document")))
    {
    	AfxMessageBox(_T("Couldn't create dispatch to Ultrasound Document."));
    }
    else
    {
    	// This kicks the system into imaging mode.
    	// This is required to be the first operation.
    	TRY
    	{
    		m_tt2000Object.InitTT2000();
    		m_tt2000Object.ShowWindow(0, -1, -1, -1, -1, 1); // hide the window
    	}
    	CATCH(COleDispatchException, pEx)
    	{
    		// show an error message to the user.
    		pEx->ReportError();
    		return;
    	}
    	END_CATCH
    }
    short tgcPos[8];
    m_tt2000Object.GetTGCPositions(&tgcPos[0], &tgcPos[1],
    	&tgcPos[2], &tgcPos[3], &tgcPos[4], &tgcPos[5],
    	&tgcPos[6], &tgcPos[7]);
    m_tt2000Object.SetTGCPositions(tgcPos[0], tgcPos[1],
    	tgcPos[2], tgcPos[3], tgcPos[4], tgcPos[5],
    	tgcPos[6], tgcPos[7]);
    
    // show the window on top, at 10,20 with a size of 600x400
    m_tt2000Object.ShowWindow(2, 10, 20, 600, 400, 0);
    m_tt2000Object.FreezeImage();
    m_tt2000Object.ResumeLiveImaging();
    
    // test fname
    CComBSTR bstrFname(OLESTR("NewSnap.bmp"));
    m_tt2000Object.ExportBitmapWithSpatialInfo(&(bstrFname.m_str));
    
    // test base preset
    CComBSTR bstrPresetName(OLESTR("CARDIAC"));
    m_tt2000Object.LoadPreset(&(bstrPresetName.m_str));
    
    short size = 1;
    m_tt2000Object.ChangePatientSize(size);
    

    CPatientInfo Class

    CPatientInfo class CPatientInfo

    The CPatientInfo class

    See Also IPatientInfo

  • CPatientInfo::GetAge
  • CPatientInfo::GetComment
  • CPatientInfo::GetDOB
  • CPatientInfo::GetFirstName
  • CPatientInfo::GetGender
  • CPatientInfo::GetLastName
  • CPatientInfo::GetMiddleInitial
  • CPatientInfo::GetPatientID
  • CPatientInfo::SetAge
  • CPatientInfo::SetComment
  • CPatientInfo::SetDOB
  • CPatientInfo::SetFirstName
  • CPatientInfo::SetGender
  • CPatientInfo::SetLastName
  • CPatientInfo::SetMiddleInitial
  • CPatientInfo::SetPatientID


  • CPatientInfo::GetAge

    short CPatientInfo::GetAge(void)

    Get the Patient Age

    Return Value

    short integer value Age

    Back to CPatientInfo


    CPatientInfo::GetComment

    BSTR CPatientInfo::GetComment(void)

    Get the Patient Comment

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CPatientInfo


    CPatientInfo::GetDOB

    DATE CPatientInfo::GetDOB(void)

    Get the Patient Date Of Birth

    Return Value

    DATE automation type value Date Of Birth

    Back to CPatientInfo


    CPatientInfo::GetFirstName

    BSTR CPatientInfo::GetFirstName(void)

    Get the Patient FirstName

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CPatientInfo


    CPatientInfo::GetGender

    short CPatientInfo::GetGender(void)

    Get the Patient Gender

    Return Value

    short integer value Gender
    0 - Other
    1 - Male
    2 - Female

    Back to CPatientInfo


    CPatientInfo::GetLastName

    BSTR CPatientInfo::GetLastName(void)

    Get the Patient LastName

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CPatientInfo


    CPatientInfo::GetMiddleInitial

    BSTR CPatientInfo::GetMiddleInitial(void)

    Get the Patient Middle Initial

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CPatientInfo


    CPatientInfo::GetPatientID

    BSTR CPatientInfo::GetPatientID(void)

    Get the Patient PatientID

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CPatientInfo


    CPatientInfo::SetAge

    void CPatientInfo::SetAge(short nNewValue)

    Set the Patient Age

    Parameters

    nNewValue
    short value new Age

    Back to CPatientInfo

    CPatientInfo::SetComment

    void CPatientInfo::SetComment(LPCTSTR lpszNewValue)

    Set the Patient Comment

    Parameters

    lpszNewValue
    new comment

    Back to CPatientInfo

    CPatientInfo::SetDOB

    void CPatientInfo::SetDOB(DATE newValue)

    Set the Patient Date Of Birth

    Parameters

    newValue
    new Date Of Birth

    Back to CPatientInfo

    CPatientInfo::SetFirstName

    void CPatientInfo::SetFirstName(LPCTSTR lpszNewValue)

    Set the Patient FirstName

    Parameters

    lpszNewValue
    new first name

    Back to CPatientInfo

    CPatientInfo::SetGender

    void CPatientInfo::SetGender(short nNewValue)

    Set the Patient Gender

    Parameters

    nNewValue
    patient gender
    0 - Other
    1 - Male
    2 - Female

    Back to CPatientInfo

    CPatientInfo::SetLastName

    void CPatientInfo::SetLastName(LPCTSTR lpszNewValue)

    Set the Patient LastName

    Parameters

    lpszNewValue
    new last name

    Back to CPatientInfo

    CPatientInfo::SetMiddleInitial

    void CPatientInfo::SetMiddleInitial(LPCTSTR lpszNewValue)

    Set the Patient MiddleInitial

    Parameters

    lpszNewValue
    new middle initial

    Back to CPatientInfo

    CPatientInfo::SetPatientID

    void CPatientInfo::SetPatientID(LPCTSTR lpszNewValue)

    Set the Patient PatientID

    Parameters

    lpszNewValue
    new patient id

    Back to CPatientInfo

    CStudyInfo Class

    CStudyInfo class CStudyInfo

    The CStudyInfo class

    See Also IStudyInfo

  • CStudyInfo::GetDate
  • CStudyInfo::GetLocation
  • CStudyInfo::GetSize
  • CStudyInfo::GetSonographer
  • CStudyInfo::GetType
  • CStudyInfo::SetDate
  • CStudyInfo::SetLocation
  • CStudyInfo::SetSize
  • CStudyInfo::SetSonographer
  • CStudyInfo::SetType


  • CStudyInfo::GetDate

    DATE CStudyInfo::GetDate(void)

    Get the Study Date

    Return Value

    Study date

    Back to CStudyInfo


    CStudyInfo::GetLocation

    BSTR CStudyInfo::GetLocation(void)

    Get the Study Location

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CStudyInfo


    CStudyInfo::GetSize

    short CStudyInfo::GetSize(void)

    Get the Study size

    Return Value

    short value study size
    0 - Small
    1 - Medium
    2 - Large

    Back to CStudyInfo


    CStudyInfo::GetSonographer

    BSTR CStudyInfo::GetSonographer(void)

    Get the Study Sonographer

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CStudyInfo


    CStudyInfo::GetType

    short CStudyInfo::GetType(void)

    Get the Study Type

    Return Value

    short value study type
    0 - NoExam
    1 - Abdominal
    2 - Cardiac
    3 - Obstetrical
    4 - Pelvic
    5 - DVT
    6 - Carotid
    7 - Venous
    8 - Arterial
    9 - Thyroid
    10 - Testes
    11 - Breast
    12 - Musculoskeletal
    13 - Endovaginal
    14 - Prostate

    Back to CStudyInfo


    CStudyInfo::SetDate

    void CStudyInfo::SetDate(DATE newValue)

    Set the Study Date

    Parameters

    newValue
    new date

    Back to CStudyInfo

    CStudyInfo::SetLocation

    void CStudyInfo::SetLocation(LPCTSTR lpszNewValue)

    Set the Study Location

    Parameters

    lpszNewValue
    new location

    Back to CStudyInfo

    CStudyInfo::SetSize

    void CStudyInfo::SetSize(short nNewValue)

    Set the Study size

    Parameters

    nNewValue
    new size
    0 - Small
    1 - Medium
    2 - Large

    Back to CStudyInfo

    CStudyInfo::SetSonographer

    void CStudyInfo::SetSonographer(LPCTSTR lpszNewValue)

    Set the Study Sonographer

    Parameters

    lpszNewValue
    new sonographer

    Back to CStudyInfo

    CStudyInfo::SetType

    void CStudyInfo::SetType(short nNewValue)

    Set the Study Type

    Parameters

    nNewValue
    new study type
    0 - NoExam
    1 - Abdominal
    2 - Cardiac
    3 - Obstetrical
    4 - Pelvic
    5 - DVT
    6 - Carotid
    7 - Venous
    8 - Arterial
    9 - Thyroid
    10 - Testes
    11 - Breast
    12 - Musculoskeletal
    13 - Endovaginal
    14 - Prostate

    Back to CStudyInfo

    CUltrasoundDoc Class

    CUltrasoundDoc class CUltrasoundDoc

    The IDocumentDisp class, Terason 2000 Ultrasound dispatch interface

    See Also IDocumentDisp

  • CUltrasoundDoc::ChangePatientSize
  • CUltrasoundDoc::ExportBitmapWithSpatialInfo
  • CUltrasoundDoc::FreezeImage
  • CUltrasoundDoc::GetPatientInfo
  • CUltrasoundDoc::GetStatusFlags
  • CUltrasoundDoc::GetStudyInfo
  • CUltrasoundDoc::GetTGCPositions
  • CUltrasoundDoc::InitTT2000
  • CUltrasoundDoc::InvertRightLeft
  • CUltrasoundDoc::InvertUpDown
  • CUltrasoundDoc::LoadPreset
  • CUltrasoundDoc::ResumeLiveImaging
  • CUltrasoundDoc::SetBrightness
  • CUltrasoundDoc::SetContrast
  • CUltrasoundDoc::SetDepth
  • CUltrasoundDoc::SetFocusDepth
  • CUltrasoundDoc::SetMap
  • CUltrasoundDoc::SetPalette
  • CUltrasoundDoc::SetPersistence
  • CUltrasoundDoc::SetSmoothing
  • CUltrasoundDoc::SetTGCPositions
  • CUltrasoundDoc::SetWindowPos
  • CUltrasoundDoc::ShowMenuBar
  • CUltrasoundDoc::ShowTitleBar
  • CUltrasoundDoc::ShowToolBars
  • CUltrasoundDoc::ShowWindow
  • CUltrasoundDoc::VersionString


  • CUltrasoundDoc::ChangePatientSize

    void CUltrasoundDoc::ChangePatientSize(short size)

    Change to the specified patient size.

    Parameters

    size
    Patient size:
    0 - small (shallow)
    1 - medium (medium)
    2 - large (deep)

    Back to CUltrasoundDoc

    CUltrasoundDoc::ExportBitmapWithSpatialInfo

    void CUltrasoundDoc::ExportBitmapWithSpatialInfo(BSTR* filename)

    Export current image as a bitmap with corresponding spacial info in text file.

    Parameters

    filename
    Name of file to create.

    Back to CUltrasoundDoc

    CUltrasoundDoc::FreezeImage

    void CUltrasoundDoc::FreezeImage(void)

    Freeze the current image.

    Back to CUltrasoundDoc


    CUltrasoundDoc::GetPatientInfo

    LPDISPATCH CUltrasoundDoc::GetPatientInfo(void)

    Get the PatientInfo object

    Return Value

    Dispatch pointer to the PatientInfo object

    Back to CUltrasoundDoc


    CUltrasoundDoc::GetStatusFlags

    void CUltrasoundDoc::GetStatusFlags(void CUltrasoundDoc:: GetStatusFlags)

    Get the StatusFlags bitfield

    Parameters

    GetStatusFlags
    long used as StatusFlags bitfield
    0x00000001 - Probe Test Busy
    0x00000002 - System Initialization Busy
    0x00000004 - Image Export Busy

    Back to CUltrasoundDoc

    CUltrasoundDoc::GetStudyInfo

    LPDISPATCH CUltrasoundDoc::GetStudyInfo(void)

    Get the StudyInfo object

    Return Value

    Dispatch pointer to the StudyInfo object

    Back to CUltrasoundDoc


    CUltrasoundDoc::GetTGCPositions

    void CUltrasoundDoc::GetTGCPositions(short* p1, short* p2, short* p3, short* p4, short* p5, short* p6, short* p7, short* p8)

    Get the 8 TGC control positions (range 1-60).

    Parameters

    p1
    TGC control 1 value

    p2
    TGC control 2 value

    p3
    TGC control 3 value

    p4
    TGC control 4 value

    p5
    TGC control 5 value

    p6
    TGC control 6 value

    p7
    TGC control 7 value

    p8
    TGC control 8 value

    Back to CUltrasoundDoc

    CUltrasoundDoc::InitTT2000

    void CUltrasoundDoc::InitTT2000(void)

    Init the TT2000 window and begin imaging. (This must be called first!!!)

    Back to CUltrasoundDoc


    CUltrasoundDoc::InvertRightLeft

    void CUltrasoundDoc::InvertRightLeft(void)

    Invert the image right-left

    Back to CUltrasoundDoc


    CUltrasoundDoc::InvertUpDown

    void CUltrasoundDoc::InvertUpDown(void)

    Invert the image up-down

    Back to CUltrasoundDoc


    CUltrasoundDoc::LoadPreset

    void CUltrasoundDoc::LoadPreset(BSTR* name)

    Load the specified preset file.

    Parameters

    name
    Name of preset file to load.

    Back to CUltrasoundDoc

    CUltrasoundDoc::ResumeLiveImaging

    void CUltrasoundDoc::ResumeLiveImaging(void)

    Resume live imaging.

    Back to CUltrasoundDoc


    CUltrasoundDoc::SetBrightness

    void CUltrasoundDoc::SetBrightness(short brightValue)

    Set the image brightness

    Parameters

    brightValue
    (VB type Integer) range [-80 thru 80]

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetContrast

    void CUltrasoundDoc::SetContrast(short contrastValue)

    Set the image contrast

    Parameters

    contrastValue
    (VB type Integer) range [100 thru 4095]

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetDepth

    void CUltrasoundDoc::SetDepth(short depth)

    Set the imaging depth

    Parameters

    depth
    (VB type Integer) requested depth in mm.
    Valid ranges are based on probe type:
    Curved Linear [40 thru 220]
    Phased Array [60 thru 240]
    Linear Array [30 thru 80]
    Endocavity [40 thru 100]

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetFocusDepth

    void CUltrasoundDoc::SetFocusDepth(short focus)

    Set the imaging focus depth

    Parameters

    focus
    (VB type Integer) requested focus depth in mm.
    Valid focal points are based on probe type:
    Curved Linear [10, 25, 40, 60, 80, 100, 130, 160]
    Phased Array [30, 40, 55, 70, 85, 100, 130, 165]
    Linear Array [06, 13, 20, 28, 35, 45, 55, 65]
    Endocavity [13, 20, 28, 35, 45, 55, 65, 75]

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetMap

    void CUltrasoundDoc::SetMap(BSTR FAR* mapName)

    Set the image map

    Parameters

    mapName
    name of map [A,B,C,D,E,F]

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetPalette

    void CUltrasoundDoc::SetPalette(BSTR FAR* palName)

    Set the imaging palette

    Parameters

    palName
    name of palette:
    gray
    tan
    flame
    sepia
    magenta
    sage
    rainbow
    cobalt

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetPersistence

    void CUltrasoundDoc::SetPersistence(short persValue)

    Set the imaging persistence

    Parameters

    persValue
    (VB type Integer) range [0 thru 4]

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetSmoothing

    void CUltrasoundDoc::SetSmoothing(BSTR FAR* smoothName)

    Set the image smoothing

    Parameters

    smoothName
    name of smoothing [A,B,C,D,E]

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetTGCPositions

    void CUltrasoundDoc::SetTGCPositions(short p1, short p2, short p3, short p4, short p5, short p6, short p7, short p8)

    Set the 8 TGC control positions (range 1-60).

    Parameters

    p1
    TGC control 1 value

    p2
    TGC control 2 value

    p3
    TGC control 3 value

    p4
    TGC control 4 value

    p5
    TGC control 5 value

    p6
    TGC control 6 value

    p7
    TGC control 7 value

    p8
    TGC control 8 value

    Back to CUltrasoundDoc

    CUltrasoundDoc::SetWindowPos

    void CUltrasoundDoc::SetWindowPos(long hWndInsertAfter, short x, short y, short cx, short cy, short uFlags)

    The SetWindowPos function changes the size, position, and Z order of a child, pop-up, or top-level window. (see Win32 API Reference)

    Parameters

    hWndInsertAfter
    placement-order handle

    x
    horizontal position

    y
    vertical position

    cx
    width

    cy
    height

    uFlags
    window-positioning options

    Back to CUltrasoundDoc

    CUltrasoundDoc::ShowMenuBar

    void CUltrasoundDoc::ShowMenuBar(short bShow)

    Set the display state of the menu bar

    Parameters

    bShow

    0 - Hide the Window
    1 - Show the Window

    Back to CUltrasoundDoc

    CUltrasoundDoc::ShowTitleBar

    void CUltrasoundDoc::ShowTitleBar(short bShow)

    Set the display state of the title bar

    Parameters

    bShow

    0 - Hide the Window
    1 - Show the Window

    Back to CUltrasoundDoc

    CUltrasoundDoc::ShowToolBars

    void CUltrasoundDoc::ShowToolBars(long toolbarMask)

    Display the ToolBars specified in the mask, hide all others

    Parameters

    toolbarMask
    long used as a bitfield to specify toolbars
    Logically OR the following bitfields together in order to specify the toolbars to Show:
    0x00000001 - File
    0x00000002 - Freeze
    0x00000004 - Measurement
    0x00000008 - Playback
    0x00000010 - ScanMode
    0x00000020 - ImageControlBar
    0x00000040 - TerasonExplorer
    0x00000080 - StatusBar

    Back to CUltrasoundDoc

    CUltrasoundDoc::ShowWindow

    void CUltrasoundDoc::ShowWindow(short zorder, short x, short y, short cx, short cy, short flags)

    Show TT2000 Window at the specified Z-order, location, and size. If the x and y are both -1 then no location change. If the cx and cy are both -1 then no size change.

    Parameters

    zorder
    0 - No change in Z-order
    1 - Places the window at the bottom of the Z-order
    2 - Places the window at the top of the Z-order
    3 - Places the window above all nontopmost windows.
    4 - Repositions the window to the top of all nontopmost windows, that is, behind all topmost windows. This flag has no effect if the window is already a nontopmost window.

    x
    screen x coordinate

    y
    screen y coordinate

    cx
    screen width

    cy
    screen height

    flags
    flags
    0 - Show the Window
    1 - Hide the Window

    Back to CUltrasoundDoc

    CUltrasoundDoc::VersionString

    BSTR CUltrasoundDoc::VersionString(void)

    Returns the version information in a String.

    Return Value

    Note: Per rules of COM, BSTR's are allocated,
    by this function, but must be freed by the caller.

    Back to CUltrasoundDoc


    IDocumentDisp Interface

    This is the Terason 2000 Ultrasound COM automation dispatch interface. All usage of this interface begins with creating a dispatch object and then calling the InitTT2000 method on the dispatch object.

    Properties

    PatientInfo
    Patient info object. This is a read only property. See IPatientInfo

    StudyInfo
    Study info object. See IStudyInfo

    Methods

    InitTT2000
    Initialize the TT2000 imaging window. This is a required step before calling any other interface methods.

    FreezeImage
    Freeze the current image.

    ResumeLiveImaging
    Resume live imaging.

    ExportBitmapWithSpatialInfo filename
    Export image as bitmap with corresponding spacial information text file.

    LoadPreset presetname
    Load the specified preset file.

    ChangePatientSize size
    Change to the specified patient size.

    GetTGCPositions &tgc1,&tgc2,&tgc3,&tgc4,&tgc5,&tgc6,&tgc7,&tgc8
    Get the active TGC control values (range 1-60).

    SetTGCPositions tgc1,tgc2,tgc3,tgc4,tgc5,tgc6,tgc7,tgc8
    Set the active TGC control values (range 1-60).

    VersionString
    Return a string containing version and build info.

    ShowWindow zorder,x,y,cx,cy,flags
    Show the imaging window at specific zorder, location, and size.
    Notes:
    If both x and y are -1 then no location change.
    If both cx and cy are -1 then no size change.

    SetWindowPos hWndInsertAfter,x,y,cx,cy,uFlags
    The SetWindowPos function changes the size, position, and Z order of a child, pop-up, or top-level window.(see Win32 API Reference)

    SetDepth depth
    Set the imaging depth

    SetFocusDepth focus
    Set the imaging focus depth

    SetPalette palName
    Set the imaging palette

    SetSmoothing smoothName
    Set the image smoothing

    SetPersistence persValue
    Set the image persistence

    SetMap mapName
    Set the image map

    SetBrightness brightValue
    Set the image brightness

    SetContrast contrastValue
    Set the image contrast

    ShowTitleBar bShow
    Set the display state of the TitleBar

    ShowMenuBar bShow
    Set the display state of the MenuBar

    ShowToolBars toolbarMask
    Display the ToolBars specified in the mask, hide all others.

    InvertRightLeft
    Invert the image right-left

    InvertUpDown
    Invert the image up-down

    GetStatusFlags &StatusFlags
    Get the Status Flags bitfield void GetStatusFlags(long* StatusFlags);

    Parameters

    filename
    BSTR* Specifies the filename for the bitmap export.

    presetname
    BSTR* Specifies the name of the preset.

    size
    short (VB type Integer)
    0 - small
    1 - medium
    2 - large

    &tgc1-8
    short* (VB type Integer By Ref) TGC control value

    tgc1-8
    short (VB type Integer) TGC control value

    zorder
    short (VB type Integer) zorder:
    0 - No change in Z-order
    1 - Places the window at the bottom of the Z-order
    2 - Places the window at the top of the Z-order
    3 - Places the window above all nontopmost windows.
    4 - Repositions the window to the top of all nontopmost windows, that is, behind all topmost windows. This flag has no effect if the window is already a nontopmost window.

    x
    short (VB type Integer) x screen coord

    y
    short (VB type Integer) y screen coord

    cx
    short (VB type Integer) window width (screen coords)

    cy
    short (VB type Integer) window height (screen coords)

    flags
    short (VB type Integer) flags:
    0 - Show the Window
    1 - Hide the Window

    depth
    short (VB type Integer) requested depth in mm.
    Valid ranges are based on probe type:
    Curved Linear [40 thru 220]
    Phased Array [60 thru 240]
    Linear Array [30 thru 80]
    Endocavity [40 thru 100]

    focus
    short (VB type Integer) requested focus depth in mm.
    Valid focal points are based on probe type:
    Curved Linear [10, 25, 40, 60, 80, 100, 130, 160]
    Phased Array [30, 40, 55, 70, 85, 100, 130, 165]
    Linear Array [06, 13, 20, 28, 35, 45, 55, 65]
    Endocavity [13, 20, 28, 35, 45, 55, 65, 75]

    palName
    BSTR * name of palette:
    gray
    tan
    flame
    sepia
    magenta
    sage
    rainbow
    cobalt

    smoothName
    BSTR * name of smoothing [A,B,C,D,E]

    persValue
    short (VB type Integer) range [0 thru 4]

    mapName
    BSTR * name of map [A,B,C,D,E,F]

    brightValue
    short (VB type Integer) range [-80 thru 80]

    contrastValue
    short (VB type Integer) range [100 thru 4095]

    bShow
    short (VB type Integer)
    0 - Hide the Window
    1 - Show the Window

    toolbarMask
    long used as a bitfield to specify toolbars
    Logically OR the following bitfields together in order to specify the toolbars:
    0x00000001 - File
    0x00000002 - Freeze
    0x00000004 - Measurement
    0x00000008 - Playback
    0x00000010 - ScanMode
    0x00000020 - ImageControlBar
    0x00000040 - TerasonExplorer
    0x00000080 - StatusBar

    &StatusFlags
    long* (VB type Long By Ref) StatusFlags bitfield
    0x00000001 - Probe Test Busy
    0x00000002 - System Initialization Busy
    0x00000004 - Image Export Busy

    See Also CUltrasoundDoc


    IPatientInfo Interface

    This is the PatientInfo object. This object is a property of IDocumentDisp and should not be created independently.

    Properties

    short Gender
    (VB Type Integer) Patient gender (read/write)
    0 - Other
    1 - Male
    2 - Female

    short Age
    (VB Type Integer) Patient age (read only)
    This value is relative to the Date of Birth value. This value is set via the DOB property being set.

    DATE DOB
    Patient Date of Birth (read/write)
    Setting this value also sets the Age property.

    BSTR FirstName
    (VB Type String) Patient First Name (read/write)

    BSTR LastName
    (VB Type String) Patient Last Name (read/write)

    BSTR MiddleInitial
    (VB Type String) Patient Middle Initial (read/write)

    BSTR PatientID
    (VB Type String) Patient Identification (read/write)

    BSTR Comment
    (VB Type String) Patient Comment (read/write)

    See Also CPatientInfo


    IStudyInfo Interface

    This is the StudyInfo object. This object is a property of IDocumentDisp and should not be created independently.

    Properties

    DATE Date
    Study Date (read/write)

    short Type
    (VB Type Integer) Study Type (read/write)
    0 - NoExam
    1 - Abdominal
    2 - Cardiac
    3 - Obstetrical
    4 - Pelvic
    5 - DVT
    6 - Carotid
    7 - Venous
    8 - Arterial
    9 - Thyroid
    10 - Testes
    11 - Breast
    12 - Musculoskeletal
    13 - Endovaginal
    14 - Prostate

    short Size
    (VB Type Integer) Study Size (read/write)
    0 - Small
    1 - Medium
    2 - Large

    BSTR Location
    (VB Type String) Study Location (read/write)

    BSTR Sonographer
    (VB Type String) Study Sonographer (read/write)

    See Also CPatientInfo