SetIndex function
为指定索引器设置索引记录值
Function:
bool UAPI SetIndex(
int hIndex,
LPCSTR lpcName,
LPCSTR lpcValue
);
Parameters:
- hIndex [in]:索引器句柄
Notes:索引器句柄由 CreateIndex function 或 OpenIndex function 所返回
- lpcName [in]:记录名
- lpcValue [in]:记录值
Return value:
- Type:BOOL
- Text:设置索引记录值成功返回 TRUE,否则返回 FALSE,函数失败返回 FALSE
Remarks:
- SetIndex function 为其索引器所设置的索引记录值是可以被覆盖的,如若参数 lpcName 所指定的记录值已存在则其索引值将会被覆盖,而不是返回 FALSE
- SetIndex function 考虑到其执行性能因素,因此采取最小化参数合法检查,开发者应自行确定其参数是否正确
Requirements:
| Keyword | Value |
|---|---|
| Minimum Agine Version | 171012.1 |
| Minimum SDK Version | 171012.1 |
| Header File | h.index |
| Library Server | kext |