EsbGetObject

サーバーまたはクライアントのオブジェクト・システムからローカル・ファイルにオブジェクトをコピーし、オプションでロックします。

構文

            EsbGetObject
             (
            hCtx, ObjType, AppName, DbName, ObjName, LocalName, isLock
            )
ByVal 
            hCtx
                  As Long
ByVal 
            ObjType
               As Long
ByVal 
            AppName
               As String
ByVal 
            DbName
                As String
ByVal 
            objName
               As String
ByVal 
            LocalName
             As String
ByVal 
            isLock
                As Integer
         

備考

オブジェクトをロックするには、そのオブジェクトがサーバーに存在している必要があり、かつ他のユーザーによってロックされていないことが必要です。クライアント上でのロックはサポートされていません。

戻り値

正常終了の場合は、オブジェクトはLocalNameで指定されているローカル・ファイルにコピーされます。

アクセス

この関数を使用するには、呼出し元は、オブジェクトがある指定したコピー元アプリケーションまたはデータベース(あるいはその両方)に対して、適切なレベルのアクセス権(オブジェクト・タイプによって異なる)を持っている必要があります。オブジェクトをロックするには(ロック・フラグがTRUE)、呼出し元は、指定したコピー先アプリケーション、またはオブジェクトが含まれているデータベースに対して、アプリケーションまたはデータベース・マネージャの権限(ESB_PRIV_APPDESIGNまたはESB_PRIV_DBDESIGN)を持っている必要があります。

例

         Declare Function EsbGetObject Lib "ESBAPIN" (ByVal hCtx As Long, ByVal ObjType As Integer, ByVal AppName As String, ByVal DbName As String, ByVal ObjName As String, ByVal LocalName As String, ByVal Lock As Integer)
 As Long
 
 Sub ESB_GetObject ()
   Dim sts As Long
   Dim AppName As String
   Dim DbName As String
   Dim ObjName As String
   Dim ObjType As Long
   Dim LocalName As String
   Dim Lock As Integer   AppName = "Sample"
   DbName = "Basic"
   ObjName = "Basic"
   ObjType = ESB_OBJTYPE_OUTLINE
   LocalName = "C:\ESSBASE\CLIENT\BASIC.OTL" 
   Lock = ESB_YES   '***********
   ' Get Object 
   '***********
   sts = EsbGetObject (hCtx, ObjType, AppName,
         DbName, ObjName, LocalName, Lock) 
End Sub
      

関連トピック

• EsbGetObjectInfo
• EsbListObjects
• EsbLockObject
• EsbPutObject
• EsbUnlockObject