GetNote

Your Ad Here

Syntax

SapObject.SapModel.RespCombo.GetNote

VB6 Procedure

Function GetNote(ByVal Name As String, ByRef Note As String) As Long

Parameters

Name

The name of an existing response combination.

Note

The user note, if any, included with the specified combination.

Remarks

This function retrieves the user note for specified response combination. The note may be blank.

The function returns zero if the note is successfully retrieved, otherwise it returns a nonzero value.

VBA Example

Sub GetComboNote()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim Note As String

   'create Sap2000 object
      Set SapObject = New SAP2000.SapObject

   'start Sap2000 application
      SapObject.ApplicationStart

   'create SapModel object
      Set SapModel = SapObject.SapModel

   'initialize model
      ret = SapModel.InitializeNewModel

   'create model from template
      ret = SapModel.File.New2DFrame(PortalFrame, 3, 124, 3, 200)

   'add combo
      ret = SapModel.RespCombo.Add("COMB1", 0)

   'add note to combo
      ret = SapModel.RespCombo.SetNote("COMB1", "My combo note")

   'get note for combo
      ret = SapModel.RespCombo.GetNote("COMB1", Note)

   'close Sap2000
      SapObject.ApplicationExit False
      Set SapModel = Nothing
      Set SapObject = Nothing
End Sub

Release Notes

Initial release in version 11.00.