1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
#if defined(OS400) && (__OS400_TGTVRM__ >= 510)
#pragma datamodel(P128)
#endif
/*********************************************************************/
/* */
/* Licensed Materials - Property of IBM */
/* */
/* L-GHUS-5VMPGW, L-GHUS-5S3PEE */
/* (C) Copyright IBM Corp. 1989, 2005 All Rights Reserved */
/* */
/* US Government Users Restricted Rights - Use, duplication or */
/* disclosure restricted by GSA ADP Schedule Contract with */
/* IBM Corp. */
/* */
/*********************************************************************/
/* Note Storage File Search Package Definitions */
#ifndef NSF_SEARCH_DEFS
#define NSF_SEARCH_DEFS
#ifndef NSF_DEFS
#include "nsfdata.h"
#endif
#ifndef MISC_DEFS
#include "misc.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* Search Flag Definitions */
#define SEARCH_ALL_VERSIONS 0x0001 /* Include deleted and non-matching notes in search */
/* (ALWAYS "ON" in partial searches!) */
#define SEARCH_SUMMARY 0x0002 /* TRUE to return summary buffer with each match */
#define SEARCH_FILETYPE 0x0004 /* For directory mode file type filtering */
/* If set, "NoteClassMask" is treated */
/* as a FILE_xxx mask for directory filtering */
#define SEARCH_NOTIFYDELETIONS 0x0010 /* Set NOTE_CLASS_NOTIFYDELETION bit of NoteClass for deleted notes */
#define SEARCH_ALLPRIVS 0x0040 /* return error if we don't have full privileges */
#define SEARCH_SESSION_USERNAME 0x0400 /* Use current session's user name, not server's */
#define SEARCH_NOABSTRACTS 0x1000 /* Filter out "Truncated" documents */
#define SEARCH_DATAONLY_FORMULA 0x4000 /* Search formula applies only to
data notes, i.e., others match */
/* This descriptor is embedded in the search queue entry. Note: The
information returned in the "summary" field is always returned in
machine-independent canonical form.
Note: In DIRECTORY searches, the following information is returned
in the SEARCH_MATCH structure (build 86 & later only):
OriginatorID.File NSF modified time (later of data & non-data modified time)
OriginatorID.Note 0 (unused)
OriginatorID.SequenceTime NSF's Replica ID (Used by NSFMakeReplicaFormula)
ID.Note NSF's Replica ID
ID.File NSF's DBID
*/
/* SERetFlags values (bit-field) */
#define SE_FNOMATCH 0x00 /* does not match formula (deleted or updated) */
#define SE_FMATCH 0x01 /* matches formula */
#define SE_FTRUNCATED 0x02 /* document truncated */
#define SE_FPURGED 0x04 /* note has been purged. Returned only when SEARCH_INCLUDE_PURGED is used */
#define SE_FNOPURGE 0x08 /* note has no purge status. Returned only when SEARCH_FULL_DATACUTOFF is used */
#define SE_FSOFTDELETED 0x10 /* if SEARCH_NOTIFYDELETIONS: note is soft deleted; NoteClass&NOTE_CLASS_NOTIFYDELETION also on (off for hard delete) */
/* If recompiling a V3 API application and you used the MatchesFormula field
the following code change should be made:
For V3:
1) if (SearchMatch.MatchesFormula == SE_FMATCH)
2) if (SearchMatch.MatchesFormula == SE_FNOMATCH)
3) if (SearchMatch.MatchesFormula != SE_FMATCH) is equivalent to 2)
4) if (SearchMatch.MatchesFormula != SE_FNOMATCH) is equivalent to 1)
For V4
1) if (SearchMatch.SERetFlags & SE_FMATCH)
2) if (!(SearchMatch.SERetFlags & SE_FMATCH))
*/
typedef struct {
GLOBALINSTANCEID ID; /* identity of the note within the file */
ORIGINATORID OriginatorID; /* identity of the note in the universe */
WORD NoteClass; /* class of the note */
BYTE SERetFlags; /* MUST check for SE_FMATCH! */
BYTE Privileges; /* note privileges */
WORD SummaryLength; /* length of the summary information */
/* 54 bytes to here */
/* now comes an ITEM_TABLE with Summary Info */
} SEARCH_MATCH;
/* function templates */
typedef STATUS (LNCALLBACKPTR NSFSEARCHPROC)
(void far *EnumRoutineParameter,
SEARCH_MATCH far *SearchMatch,
ITEM_TABLE far *SummaryBuffer);
STATUS LNPUBLIC NSFSearch (DBHANDLE hDB,
FORMULAHANDLE hFormula,
char far *ViewTitle,
WORD SearchFlags,
WORD NoteClassMask,
TIMEDATE far *Since,
NSFSEARCHPROC EnumRoutine,
void far *EnumRoutineParameter,
TIMEDATE far *retUntil);
STATUS LNPUBLIC NSFSearchWithUserNameList (DBHANDLE hDB,
FORMULAHANDLE hFormula,
char far *ViewTitle,
WORD SearchFlags,
WORD NoteClassMask,
TIMEDATE far *Since,
NSFSEARCHPROC EnumRoutine,
void far *EnumRoutineParameter,
TIMEDATE far *retUntil,
HANDLE nameList);
/* Formula compilation functions */
STATUS LNPUBLIC NSFFormulaCompile (char far *FormulaName, WORD FormulaNameLength,
const char far *FormulaText, WORD FormulaTextLength,
FORMULAHANDLE far *rethFormula,
WORD far *retFormulaLength,
STATUS far *retCompileError,
WORD far *retCompileErrorLine,
WORD far *retCompileErrorColumn,
WORD far *retCompileErrorOffset,
WORD far *retCompileErrorLength);
STATUS LNPUBLIC NSFFormulaDecompile(char far *pFormulaBuffer,
BOOL fSelectionFormula,
HANDLE far *rethFormulaText,
WORD far *retFormulaTextLength);
STATUS LNPUBLIC NSFFormulaMerge(FORMULAHANDLE hSrcFormula, FORMULAHANDLE hDestFormula);
STATUS LNPUBLIC NSFFormulaSummaryItem(FORMULAHANDLE hFormula, const char far *ItemName, WORD ItemNameLength);
STATUS LNPUBLIC NSFFormulaGetSize(FORMULAHANDLE hFormula, WORD far *retFormulaLength);
/* Formula computation (evaluation) functions */
STATUS LNPUBLIC NSFComputeStart(WORD Flags,
void far *pCompiledFormula,
HCOMPUTE far *rethCompute);
STATUS LNPUBLIC NSFComputeStop(HCOMPUTE hCompute);
STATUS LNPUBLIC NSFComputeEvaluate(HCOMPUTE hCompute,
NOTEHANDLE hNote,
HANDLE far *rethResult,
WORD far *retResultLength,
BOOL far *retNoteMatchesFormula,
BOOL far *retNoteShouldBeDeleted,
BOOL far *retNoteModified);
/* End of Note Storage File Search Package Definitions */
#ifdef __cplusplus
}
#endif
#endif
#if defined(OS400) && (__OS400_TGTVRM__ >= 510)
#pragma datamodel(pop)
#endif
|
