SMS_GetSiteCode

Owned by Martin Gudme Søndergaard
May 23, 2022

SMS_GetSiteCode(sSMSServer, sUserName, sPassword)

Option

Description

Type

sSMServer

The SMS Main Site Server

String

sUserName

Account performing the action on SMS server

String

sPassword

The password for the above account

String

Return Type

Boolean, TRUE if function completed successfully.

Description

Gets the site id code from the specified SMS server.
The retrieved ID will be returned in gsSMSSiteCode and gsValue.
Note that the query is performed on the server and therefore you must be sure to have the right permissions.

Specify * as password to let CapaInstaller decrypt a password already specified by CapaInstaller in registry. Notes:
sSMSServer: SMS Main Server. Sub Site Servers are not supported.

Example

<Add Function Scripting Guidelines here>

bStatus=True
If bStatus Then bStatus=IncludeScript("customlib.cis")
If bStatus Then bStatus=IncludeScriptingLibrary("CapaInstaller Scripting Library.cin")
If bStatus Then bStatus=Job_Start("WS","Get SMS site code","1.0","Capalib_test.log","INSTALL")
If bStatus Then bStatus=SMS_GetSiteCode("SMSSRV01"," FIRMDOM\CapaAdmin","Password")
Job_End(bStatus)

See Also

SMS_GetUnitIDFromName SMS_GetCollectionIDFromName SMS_AddUnitToCollection, Sys_SetEncryptedPassword