指定したユーザー名または変更日(あるいはその両方)の、アクティブ・データベースのセルにリンクされているすべてのオブジェクトを削除します。
構文
EsbLROPurgeObjects
(
hCtx, userName, purgeDate, PulCount
)
ByVal
hCtx
As Long
ByVal
userName
As String
ByVal
purgeDate
As Long
PulCount
As Long
| パラメータ | 説明 |
|---|---|
hCtx |
APIコンテキスト・ハンドル。 |
userName |
ユーザー名を指すポインタ。指定した場合、特定のユーザーが最後に変更したすべてのオブジェクトが削除されます。 |
purgeDate |
変更日。指定した場合は、特定日以前に変更されたすべてのオブジェクトが削除されます。日付は1970年1月1日以降に経過した秒数をLong値で表します。 |
PulCount |
削除されたLROカタログ・エントリの数。 |
備考
userNameとpurgeDateパラメータの両方を指定した場合、両方の基準に合致するオブジェクトが削除されます。
EsbLROPurgeObjects()は削除するオブジェクトのリストを生成します。この関数の呼出し後、EsbGetNextItemを使用して、削除した各オブジェクトの情報を取得します。コード例でこの方法を示します。
戻り値
正常終了の場合は、ESB_STS_NOERRが戻されます。それ以外の場合、エラー・コードが戻されます。
アクセス
この関数を呼び出すには、データ・セルまたはアクティブなデータベースに対してデザイン権限(ESB_PRIV_DBDESIGN)持っている必要があります。
例
Declare Function EsbLROPurgeObjects Lib "esbapin" _
(ByVal hCtx As Long, ByVal userName As String, _
ByVal purgeDate As Long, PulCount As Long) As Long
Public Sub ESB_LROPurgeObjects() Dim userName As String * ESB_USERNAMELEN
Dim purgeDate As Long
Dim Items As Long
Dim Desc As ESB_LRODESC_API_T
Dim CutOffDate As Date
Dim i As Integer Const ESB_REFERENCE_DATE = #1/1/70#
userName = "admin"
CutOffDate = #8/1/97#
purgeDate = DateDiff("s", ESB_REFERENCE_DATE, _
CutOffDate)
sts = EsbLROPurgeObjects(hCtx, userName, _
purgeDate, Items)
If sts = 0 Then
For i = 1 To Items
'*******************************
'* Get the next LRO description
'* item from the list
'******************************* sts = EsbGetNextItem(hCtx, ESB_LRO_TYPE, Desc) Next i
End If
End Sub
関連トピック