SAP2000_API_Documentation
main
introduction
getting started
accessing sap2000 from an external application
function documentation conventions
function return values
units abbreviations
visual basic concepts used in the sap2000 api
sap2000 api functions
general functions
applicationexit
applicationstart
getdatabaseunits
getmodelislocked
getpresentcoordsystem
getpresentunits
hide
initializenewmodel
setmodelislocked
setpresentcoordsystem
setpresentunits
unhide
visible
analysis model
area element functions
count
getloadgravity
getloadporepressure
getloadstrain
getloadsurfacepressure
getloadtemperature
getloaduniform
getlocalaxes
getmaterialoverwrite
getmattemp
getmodifiers
getnamelist
getobj
getoffsets
getpoints
getproperty
getthickness
gettransformationmatrix
line element functions
count
getendlengthoffset
getinsertionpoint
getloaddeformation
getloaddistributed
getloadgravity
getloadpoint
getloadstrain
getloadtargetforce
getloadtemperature
getlocalaxes
getmaterialoverwrite
getmattemp
getmodifiers
getnamelist
getobj
getpdeltaforce
getpoints
getproperty
getreleases
gettclimits
gettransformationmatrix
link element functions
count
getloaddeformation
getloadgravity
getloadtargetforce
getlocalaxes
getnamelist
getobj
getpoints
getproperty
getpropertyfd
gettransformationmatrix
plane element functions
count
getloadgravity
getloadporepressure
getloadrotate
getloadstrain
getloadsurfacepressure
getloadtemperature
getloaduniform
getlocalaxes
getmattemp
getnamelist
getobj
getpoints
getproperty
gettransformationmatrix
point element functions
count
countconstraint
countloaddispl
countloadforce
countrestraint
countspring
getconstraint
getcoordcartesian
getcoordcylindrical
getcoordspherical
getloaddispl
getloadforce
getlocalaxes
getmergenumber
getnamelist
getobj
getpatternvalue
getrestraint
getspring
getspringcoupled
gettransformationmatrix
isspringcoupled
solid element functions
count
getloadgravity
getloadporepressure
getloadstrain
getloadsurfacepressure
getloadtemperature
getlocalaxes
getmattemp
getnamelist
getobj
getpoints
getproperty
gettransformationmatrix
edit functions
edit area functions
divide
expandshrink
merge
pointadd
pointremove
edit frame functions
divideatdistance
divideatintersections
dividebyratio
extend
join
trim
edit point functions
align
connect
disconnect
merge
edit solid functions
divide
general edit functions
extrudeareatosolidlinearnormal
extrudeareatosolidlinearuser
extrudeareatosolidradial
extrudeframetoarealinear
extrudeframetoarearadial
extrudepointtoframelinear
extrudepointtoframeradial
move
replicatelinear
replicatemirror
replicateradial
file functions
new2dframe
new3dframe
newbeam
newblank
newsolidblock
newwall
openfile
save
object model
definitions
analysis case functions
count
delete
getnamelist
bridge object functions
getbridgeupdateforanalysisflag
setbridgeupdateforanalysisflag
combination functions
add
adddesigndefaultcombos
changename {combinations}
count {combinations}
countcase
delete {combinations}
deletecase
getcaselist
getnamelist
getnote
gettype
setcaselist
setnote
settype
constraint definition functions
changename
count
delete
getbeam
getbody
getconstrainttype
getdiaphragm
getequal
getline
getlocal
getnamelist
getplate
getrod
getspecialrigiddiaphragmlist
getweld
setbeam
setbody
setdiaphragm
setequal
setline
setlocal
setplate
setrod
setweld
coordinate system definition functions
changename
count
delete
getcoordsys
getnamelist
gettransformationmatrix
setcoordsys
generalized displacement functions
add {generalized displacement}
changename {generalized displacement}
countpoint
delete {generalized displacement}
deletepoint
getnamelist {generalized displacement}
count {generalized displacement}
gettype {generalized displacement}
setpoint
getpoint
settype {generalized displacement}
group definition functions
changename
clear
count
delete
getassignments
getgroup
getnamelist
setgroup
joint pattern definition functions
changename
count
delete
getnamelist
setpattern
load case functions
count
delete
getnamelist
area object functions
addbycoord
addbypoint
changename
count
delete
deleteloadgravity
deleteloadporepressure
deleteloadrotate
deleteloadstrain
deleteloadsurfacepressure
deleteloadtemperature
deleteloaduniform
deleteloaduniformtoframe
deleteloadwindpressure
deletemass
deletemodifiers
deletespring
getautomesh
getedgeconstraint
getelm
getloadgravity
getloadporepressure
getloadrotate
getloadstrain
getloadsurfacepressure
getloadtemperature
getloaduniform
getloaduniformtoframe
getloadwindpressure
getlocalaxes
getmass
getmaterialoverwrite
getmattemp
getmodifiers
getnamelist
getoffsets
getpoints
getproperty
getselected
getselectededge
getspring
getthickness
gettransformationmatrix
setautomesh
setedgeconstraint
setgroupassign
setloadgravity
setloadporepressure
setloadrotate
setloadstrain
setloadsurfacepressure
setloadtemperature
setloaduniform
setloaduniformtoframe
setloadwindpressure
setlocalaxes
setmass
setmaterialoverwrite
setmattemp
setmodifiers
setoffsets
setproperty
setselected
setselectededge
setspring
setthickness
cable object functions
addbycoord
addbypoint
changename
count
delete
deleteloaddeformation
deleteloaddistributed
deleteloadgravity
deleteloadstrain
deleteloadtargetforce
deleteloadtemperature
deletemass
deletemodifiers
getcabledata
getcablegeometry
getelm
getinsertionpoint
getloaddeformation
getloaddistributed
getloadgravity
getloadstrain
getloadtargetforce
getloadtemperature
getmass
getmaterialoverwrite
getmattemp
getmodifiers
getnamelist
getoutputstations
getpoints
getproperty
getselected
gettransformationmatrix
setcabledata
setgroupassign
setinsertionpoint
setloaddeformation
setloaddistributed
setloadgravity
setloadstrain
setloadtargetforce
setloadtemperature
setmass
setmaterialoverwrite
setmattemp
setmodifiers
setoutputstations
setproperty
setselected
frame object functions
addbycoord
addbypoint
changename
count
delete
deletefireproofing
deleteloaddeformation
deleteloaddistributed
deleteloadgravity
deleteloadpoint
deleteloadstrain
deleteloadtargetforce
deleteloadtemperature
deletemass
deletemodifiers
deletepdeltaforce
deletespring
getautomesh
getcurved
getelm
getendlengthoffset
getendskew
getfireproofing
getinsertionpoint
getloaddeformation
getloaddistributed
getloadgravity
getloadpoint
getloadstrain
getloadtargetforce
getloadtemperature
getlocalaxes
getmass
getmaterialoverwrite
getmattemp
getmodifiers
getnamelist
getoutputstations
getpdeltaforce
getpoints
getreleases
getsection
getsectionnonprismatic
getselected
getspring
gettclimits
gettransformationmatrix
gettype
setautomesh
setcurved
setendlengthoffset
setendskew
setfireproofing
setgroupassign
setinsertionpoint
setloaddeformation
setloaddistributed
setloadgravity
setloadpoint
setloadstrain
setloadtargetforce
setloadtemperature
setlocalaxes
setmass
setmaterialoverwrite
setmattemp
setmodifiers
setoutputstations
setpdeltaforce
setreleases
setsection
setselected
setspring
setstraight
settclimits
link object functions
addbycoord
addbypoint
count
changename
delete
deleteloaddeformation
deleteloadgravity
deleteloadtargetforce
getelm
getloaddeformation
getloadgravity
getloadtargetforce
getlocalaxes
getnamelist
getpoints
getproperty
getpropertyfd
getselected
gettransformationmatrix
setgroupassign
setloaddeformation
setloadgravity
setloadtargetforce
setlocalaxes
setproperty
setpropertyfd
setselected
point object functions
addcartesian
addcylindrical
addspherical
changename
count
countconstraint
countloaddispl
countloadforce
countpanelzone
countrestraint
countspring
deleteconstraint
deleteloaddispl
deleteloadforce
deletemass
deletepanelzone
deletepatternvalue
deleterestraint
deletespring
getcommonto
getconstraint
getcoordcartesian
getcoordcylindrical
getcoordspherical
getelm
getguid
getloaddispl
getloadforce
getlocalaxes
getmass
getmergenumber
getnamelist
getpanelzone
getpatternvalue
getrestraint
getselected
getspecialpoint
getspring
getspringcoupled
gettransformationmatrix
isspringcoupled
setconstraint
setgroupassign
setguid
setloaddispl
setloadforce
setlocalaxes
setmass
setmergenumber
setpanelzone
setpatternbypressure
setpatternbyxyz
setrestraint
setselected
setspecialpoint
setspring
setspringcoupled
solid object functions
addbycoord
addbypoint
changename
count
delete
deleteloadgravity
deleteloadporepressure
deleteloadstrain
deleteloadsurfacepressure
deleteloadtemperature
deletespring
getautomesh
getedgeconstraint
getelm
getloadgravity
getloadporepressure
getloadstrain
getloadsurfacepressure
getloadtemperature
getlocalaxes
getmattemp
getnamelist
getpoints
getproperty
getselected
getspring
gettransformationmatrix
setautomesh
setedgeconstraint
setgroupassign
setloadgravity
setloadporepressure
setloadstrain
setloadsurfacepressure
setloadtemperature
setlocalaxes
setmattemp
setproperty
setselected
setspring
tendon object functions
addbycoord
addbypoint
changename
count
delete
deleteloaddeformation
deleteloadforcestress
deleteloadgravity
deleteloadstrain
deleteloadtemperature
getdiscretization
getelm
getloaddeformation
getloadedgroup
getloadforcestress
getloadgravity
getloadstrain
getloadtemperature
getlocalaxes
getmattemp
getnamelist
getpoints
getproperty
getselected
gettclimits
gettendondata
gettendongeometry
gettransformationmatrix
setdiscretization
setgroupassign
setloaddeformation
setloadedgroup
setloadforcestress
setloadgravity
setloadstrain
setloadtemperature
setlocalaxes
setmattemp
setproperty
setselected
settclimits
settendondata
analyze functions
createanalysismodel
runanalysis
analysis results
results functions
areaforceshell
areajointforceplane
areajointforceshell
areastressplane
areastressshell
areastressshelllayered
assembledjointmass
basereact
basereactwithcentroid
bucklingfactor
frameforce
framejointforce
generalizeddispl
jointacc
jointaccabs
jointdispl
jointdisplabs
jointreact
jointvel
jointvelabs
linkdeformation
linkforce
linkjointforce
modalperiod
modeshape
panelzonedeformation
panelzoneforce
sectioncutanalysis
sectioncutdesign
solidjointforce
solidstress
analysis results setup functions
deselectallcasesandcombosforoutput
getcaseselectedforoutput
getcomboselectedforoutput
getoptionbasereactloc
getoptionbucklingmode
getoptiondirecthist
getoptionmodalhist
getoptionmodeshape
getoptionmultistepstatic
getoptionmultivaluedcombo
getoptionnlstatic
getoptionpsd
getoptionsteadystate
setcaseselectedforoutput
setcomboselectedforoutput
setoptionbasereactloc
setoptionbucklingmode
setoptiondirecthist
setoptionmodalhist
setoptionmodeshape
setoptionmultistepstatic
setoptionmultivaluedcombo
setoptionnlstatic
setoptionpsd
setoptionsteadystate
selection functions
all
clearselection
constraint
coordinaterange
getselected
group
invertselection
linesparalleltocoordaxis
linesparalleltoline
planexy
planexz
planeyz
previousselection
propertyarea
propertycable
propertyframe
propertylink
propertylinkfd
propertymaterial
propertysolid
propertytendon
supportedpoints
view functions
refreshview
refreshwindow
example code
example 1
alphabetized list of functions
add {combinations}
add {generalized displacement}
addcartesian
addbycoord {area object}
addbycoord {cable object}
addbycoord {frame object}
addbycoord {link object}
addbycoord {solid object}
addbycoord {tendon object}
addbypoint {area object}
addbypoint {cable object}
addbypoint {frame object}
addbypoint {link object}
addbypoint {solid object}
addbypoint {tendon object}
addcylindrical
adddesigndefaultcombos
addspherical
align
all
applicationexit
applicationstart
areaforceshell
areajointforceplane
areajointforceshell
areastressplane
areastressshell
areastressshelllayered
assembledjointmass
basereact
basereactwithcentroid
bucklingfactor
changename {area object}
changename {cable object}
changename {combinations}
changename {constraints}
changename {coordinate system}
changename {frame object}
changename {generalized displacement}
changename {group}
changename {joint pattern}
changename {link object}
changename {point}
changename {solid object}
changename {tendon object}
clear
clearselection
connect
constraint
coordinaterange
count {analysis case}
count {area element}
count {area object}
count {cable object}
count {combinations}
count {constraints}
count {coordinate system}
count {frame object}
count {generalized displacement}
count {group}
count {joint pattern}
count {line element}
count {link element}
count {link object}
count {load case}
count {plane element}
count {point element}
count {point object}
count {solid element}
count {solid object}
count {tendon object}
countcase
countconstraint {point element}
countconstraint {point object}
countloaddispl {point element}
countloaddispl {point object}
countloadforce {point element}
countloadforce {point object}
countpanelzone
countpoint
countrestraint {point element}
countrestraint {point object}
countspring {point element}
countspring {point object}
createanalysismodel
delete {analysis case}
delete {area object}
delete {cable object}
delete {combinations}
delete {constraints}
delete {coordinate system}
delete {frame object}
delete {generalized displacement}
delete {group}
delete {joint pattern}
delete {link object}
delete {load case}
delete {solid object}
delete {tendon object}
deletecase
deleteconstraint
deletefireproofing
deleteloaddeformation {cable object}
deleteloaddeformation {frame object}
deleteloaddeformation {link object}
deleteloaddeformation {tendon object}
deleteloaddispl
deleteloaddistributed {cable object}
deleteloaddistributed {frame object}
deleteloadforce
deleteloadforcestress
deleteloadgravity {area object}
deleteloadgravity {cable object}
deleteloadgravity {frame object}
deleteloadgravity {link object}
deleteloadgravity {solid object}
deleteloadgravity {tendon object}
deleteloadpoint
deleteloadporepressure {area object}
deleteloadporepressure {solid object}
deleteloadrotate
deleteloadstrain {area object}
deleteloadstrain {cable object}
deleteloadstrain {frame object}
deleteloadstrain {solid object}
deleteloadstrain {tendon object}
deleteloadsurfacepressure {area object}
deleteloadsurfacepressure {solid object}
deleteloadtargetforce {cable object}
deleteloadtargetforce {frame object}
deleteloadtargetforce {link object}
deleteloadtemperature {area object}
deleteloadtemperature {cable object}
deleteloadtemperature {frame object}
deleteloadtemperature {solid object}
deleteloadtemperature {tendon object}
deleteloaduniform
deleteloaduniformtoframe
deleteloadwindpressure
deletemass {area object}
deletemass {cable object}
deletemass {frame object}
deletemass {point object}
deletemodifiers {area object}
deletemodifiers {cable object}
deletemodifiers {frame object}
deletepanelzone
deletepatternvalue
deletepdeltaforce
deletepoint
deleterestraint
deletespring {area object}
deletespring {frame object}
deletespring {point object}
deletespring {solid object}
deselectallcasesandcombosforoutput
disconnect
divide {area object}
divide {solid object}
divideatdistance
divideatintersections
dividebyratio
expandshrink
extend
extrudeareatosolidlinearnormal
extrudeareatosolidlinearuser
extrudeareatosolidradial
extrudeframetoarealinear
extrudeframetoarearadial
extrudepointtoframelinear
extrudepointtoframeradial
frameforce
framejointforce
generalizeddispl
getassignments
getautomesh {area object}
getautomesh {frame object}
getautomesh {solid object}
getbeam
getbody
getbridgeupdateforanalysisflag
getcabledata
getcablegeometry
getcaselist
getcaseselectedforoutput
getcomboselectedforoutput
getcommonto
getconstraint {point element}
getconstraint {point object}
getconstrainttype
getcoordcartesian {point element}
getcoordcartesian {point object}
getcoordcylindrical {point element}
getcoordcylindrical {point object}