HypUpdateConnection

Oracle Smart View for OfficeのVBA関数、HypUpdateConnectionについて説明します。

クラウド・データ・プロバイダ・タイプ: Oracle Analytics Cloud - Essbase、Planning、Planning Modules、Financial Consolidation and Close、Tax Reporting

オンプレミス・データ・プロバイダ・タイプ: Oracle Essbase、Oracle Hyperion Planning、Oracle Hyperion Financial Management

説明

HypUpdateConnectionによって既存の接続が更新されます。

ノート:

既存の複数グリッド・シートの接続を更新するときに、古い接続名が存在する場合は、HypUpdateConnectionのみを使用します。HypUpdateConnectionに指定された接続名が存在しない場合、複数グリッド・シートは単一グリッドのアド・ホック・シートになります。

構文

Public Declare PtrSafe Function HypUpdateConnection Lib "HsAddin" (ByVal vtProviderType As Variant,

ByVal vtServerName As Variant

ByVal vtApplicationName As Variant

ByVal vtDatabaseName As Variant

ByVal vtProviderURL As Variant

ByVal vtFriendlyName As Variant

ByVal vtUserName As Variant

ByVal vtPassword As Variant

ByVal vtDescription As Variant

ByVal bCreateNewIfConnectionDoesnotExist As Boolean) As Long

パラメータ

vtServerName: サーバー名

vtApplicationName: アプリケーション名

vtDatabaseName: データベース名

vtProviderURL: データ・プロバイダのURL

vtFriendlyName: データ・プロバイダの接続名

vtUserName: ユーザー名

vtPassword: パスワード

vtDescription: データ・プロバイダの説明

戻り値

正常に終了した場合は0を戻し、それ以外の場合は該当するエラー・コードを戻します。

例1

接続が存在せず、新しい接続の作成がFalseである場合は、エラー・コードが-43という結果になります。

Sub UpdateConnection()
sts = HypUpdateConnection("Essbase", "EssbaseCluster-1", "Sample", "Basic",
"http://<server>:<port>/aps/SmartView", "NonExistingConnection", "<username>", "<password>", "test", False) 'will return -43, connection not found

例2

接続が存在するが、新しい接続の作成がTrueです。結果は成功で、コード0が返されます(すべてのパラメータが正しい場合)。

sts = HypUpdateConnection("Essbase", "EssbaseCluster-1", "Sample", "Basic",
"http://<server>:<port>/aps/SmartView", "NewConnection","<username>", "<password>", "test", True)'will return 0 as it will internally create
a new connection if it does not exist as last parameter is true
sts = HypUpdateConnection("Essbase", "EssbaseCluster-1", "Sample", "Basic","<server>:<port>/aps/SmartView", "NewConnection","<username>", "<password>", "newTestConnection", False)
End Sub

例3

接続が存在するが、新しい接続の作成がTrueです。結果は成功で、コード0が返されます(すべてのパラメータが正しい場合)。

Public Const serverName = "EssbaseCluster-1"
Public Const ProviderURL = "http://<server>:<port>/aps/SmartView"
Public Const HWL_application = "Sample"
Public Const HWL_db = "Basic"
 
Sub Test()
    HWL_Connection = "test_Ess"
    sts = HypDisconnectAll()
    'X = HypRemoveConnection(HWL_Connection)
    UserId = "<username>"
    UserPwd = "<password>"
    'X = HypCreateConnection(Empty, UserId, UserPwd, HYP_ESSBASE,
ProviderURL, _
        serverName, HWL_application, HWL_db, HWL_Connection,
"User_Description")
     X = HypUpdateConnection("Essbase", serverName, HWL_application, HWL_db,
ProviderURL, HWL_Connection, UserId, UserPwd, "test", True)
    z1 = HypConnect("Sheet1", UserId, UserPwd, HWL_Connection) 'To login
    
End Sub