Function GetObjMemo

 

Function GetObjMemo ( ByVal hHandle& ) As String

Purpose: Retrieve memo string for a bus, generator, load, shunt, switched shunt, transmission line, transformer, switch, phase shifter, distance relay, overcurrent relay, fuse, recloser, or relay group.

Works in:      OneLiner and Power Flow.

Parameters:     

nHandle       [in] data object handle

Return value:

Object memo field.

Remarks:

 

Example:

 

   Sub main()

   If GetEquipment( TC_PICKED, ObjHnd& ) = 0 Then

     Print "Please select an object"

     Exit Sub

   End If

   If EquipmentType( ObjHnd ) = TC_RLYGROUP Then

    RelayHnd& = 0

    While GetRelay( ObjHnd, RelayHnd ) > 0

    Print GetObjMemo( RelayHnd )

    Wend

   Else

    Print GetObjMemo( ObjHnd )

   End If

   End Sub