My Project
Public Member Functions | Public Attributes | List of all members
ParaScripting::ParaSearchResult Class Reference

it represents a search result. More...

#include <ParaScriptingIO.h>

Public Member Functions

 ParaSearchResult (CSearchResult *pResult)
 
bool IsValid ()
 check if the object is valid
 
void Release ()
 release results. More...
 
string GetRootPath ()
 get the root path
 
int GetNumOfResult ()
 get the total number of result found
 
bool AddResult (const char *sItem)
 add a new item. More...
 
string GetItem (int nIndex)
 get the item at the specified index. More...
 
object GetItemData (int nIndex, const object &output)
 get the item at the specified index. More...
 

Public Attributes

CSearchResultm_pResult
 

Detailed Description

it represents a search result.

Member Function Documentation

§ AddResult()

bool ParaScripting::ParaSearchResult::AddResult ( const char *  sItem)

add a new item.

return false if the search is completed.

§ GetItem()

string ParaScripting::ParaSearchResult::GetItem ( int  nIndex)

get the item at the specified index.

return "" if nIndex is out of range.

§ GetItemData()

object ParaScripting::ParaSearchResult::GetItemData ( int  nIndex,
const object output 
)

get the item at the specified index.

return nil if nIndex is out of range.

Parameters
output[in|out] default value.
Returns
: return the field result. If field not found, output will be returned. e.g. {filename="abc.txt", filesize=0, fileattr=0, createdate="1982-11-26", writedate="", accessdate=""} fileattr is the value same as defined in WIN32_FIND_DATA.dwFileAttributes

§ Release()

void ParaScripting::ParaSearchResult::Release ( )

release results.


The documentation for this class was generated from the following files: