文書の検索条件を指定すると、データベース内の次の文書を返します。
Set notesDocumentCollection = notesDatabase .UnprocessedSearch( formula$ , notesDateTime , maxDocs% )
formula$
String 型。検索条件を定義する Notes の @関数式です。
notesDateTime
削除日。メソッドは切り離し日以降に作成または変更された文書だけを検索します。
maxDocs%
整数。返される文書の最大数。 このパラメータに 0 を設定すると一致した文書すべてを取得します。
notesDocumentCollection
NotesDocumentCollection. 未読文書、選択条件に一致した文書、切り離し日以降に作成または変更された文書のコレクションを返します。コレクションは最も適合性の高い文書から順にソートされます。
このメソッドはエージェントまたはビューアクションスクリプトに対してのみ有効で、NotesSession の CurrentDatabase プロパティから取得した NotesDatabase オブジェクトだけで起動できます。エージェントまたはビューアクションに含まれないスクリプトでは、このメソッドは文書が 1 つも入っていない NotesDocumentCollection を返します。CurrentDatabase プロパティから取得されていない NotesDatabase オブジェクトで呼び出されたときは、このメソッドはエラーとなります。
このメソッドは次の 2 段階で動作します。
例えば、ビューのすべての選択文書を対象に実行されるエージェントの場合、UnprocessedSearch は選択文書だけを検索して、条件に一致する文書を返します。前回の実行以降に作成または変更された文書を対象とするエージェントの場合、UnprocessedSearch は NotesSession の UpdateProcessedDoc メソッドが処理済みのマークを付けていない文書だけを検索して、条件と一致する文書を返します。
次の表は UnprocessedSearch メソッドが返す文書を示します。エージェントを実行する前に文書が 1 回選択されます。
| エージェントの実行対象 |
UnprocessedSearch によって返される文書が満たさなければならないすべての要件 |
|---|---|
| データベースのすべての文書 |
[エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
| 作成または変更されたすべての文書 |
このエージェントが UpdateProcessedDoc で処理していないこと エージェントが最後に実行されてから新規作成または更新されていること [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
| ビューのすべての未読文書 |
ビューにある未読文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
| ビューのすべての文書 |
ビューにある文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
| 選択されたすべての文書 または ビューアクション |
ビューで選択されている文書 [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
| なし |
現在の文書のみ |
| 新規に受信したメール文書 |
エージェントの最終実行後にデータベースに送信されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
| 新規に更新された文書 |
エージェントの最終実行後に更新されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
| 追加された文書 |
エージェントの最終実行後にデータベースに追加されたこと [エージェントのプロパティ] インフォボックスで指定された検索条件を満たすこと このメソッドで指定された @関数の検索条件を満たすこと |
新規作成および変更された文書、新規に受信したメール文書、新規に追加された文書、新規に変更された文書で実行されるエージェントの場合、NotesSession の UpdateProcessedDoc メソッドを使用して、各文書を「処理済み」にします。「処理済み」にすると、再び変更、メール送信、追加をされないかぎり、エージェントはその文書を処理しません。このメソッドを文書ごとに呼び出さないと、エージェントは次回の実行時にも同じ文書を処理します。
UpdateProcessedDoc が処理済みのマークを付けるのは、このメソッドの呼び出し元の特定のエージェントが処理した文書だけです。あるエージェントで UpdateProcessedDoc を使用しても、他のエージェントが処理する文書には影響がありません。
その他のすべてのエージェントとビューアクションでは、UpdateProcessedDoc による影響はありません。
ビューアクションで使用されるとき、UnprocessedSearch は選択文書で実行されるエージェントの場合と同じ文書を返します。