as_DBMOpenSeqScanTable

as_DBMOpenSeqScanTable

Description
인덱스 필드에 기반한 순서로 레코드를 읽기 위한 스캔 관리자를 초기화한다.

Syntax
DBMErr as_DBMOpenSeqScanTable(TableId tableId, IndexFlag indexFlag, S32 offset, RecOrder recOrder, ScanId* scanId);

Parameters

tableId	테이블의 ID
indexFlag	primary key 필드와 secondary key 필드 중 논리적 순서의 기준이 되는 필드를 선택하는 플래그 DBM_PRIM : primary key 필드 DBM_SEC : secondary key 필드
offset	읽고자 하는 레코드의 offset(>=0) 첫번째 레코드를 얻고자하는 경우(또는 레코드가 없는 경우) offset=0
recOrderFlag	레코드의 검색 순서 DBM_INCR : increasing order DBM_DECR : decreasing order
scanId	open된 스캔 ID

Returns

value	설명
DBM_OK	성공적으로 수행된 경우
DBM_TOO_MANY_SCANS	이미 open된 스캔의 수가 NUM_SCANS인 경우
DBM_INVALID_TABLE_ID	주어진 테이블 id를 갖는 테이블이 존재하지 않는 경우
DBM_INVALID_FLAG	indexFlag가 DBM_PRIM도 DBM_SEC도 아닌 경우
DBM_INVALID_OFFSET	offset < 0이거나 offset >= (테이블의 레코드수)인 경우
DBM_OPEN_SCAN_ERR	recOrder가 DBM_INCR나 DBM_DECR이 아닌 경우
DBM_SECONDARY_INDEX_NOT_EXIST	테이블에 secondary index가 없는데도 indexFlag가 DBM_SEC인 경우
DBM_DB_NOT_INITED	데이타베이스가 초기화되어 있지 않은 경우

Comments
테이블의 전체 레코드를 키 필드에 기반한 논리적 순서로 읽을 때 사용한다. virtual delete된 레코드는 읽지 않는다.
스캔을 open한 이후, 최초로 호출되는 as_DBMGetNextRecordId 또는 as_DBMGetPrevRecordId는 처음 레코드 ID를 반환한다.

See Also
as_DBMGetNextRecordId, as_DBMGetPrevRecordId, as_DBMOpenSeqScanCategory, as_DBMOpenSeqScanTableWithCursor

Example
TableId tableId; ScanId scanId;
RecId recId; DBMErr ret=DBM_OK;
int numFields, numExistFields; FieldDataInfo fieldDataInfo;
FieldData keyData, fieldData;
IndexFlag indexFlag = DBM_PRIM;
int offset = 10;
RecOrder recOrder=DBM_INCR;

// Get tableId, catId
ret = as_DBMOpenSeqScanTable( tableId, indexFlag, offset, recOrder, &scanId);
if( ret < DBM_OK ) // error handling

numFields = NUM_FIELDS;
...
/* allocate space for fieldDataInfo */
fieldDataInfo =(FieldDataInfo*)Lmalloc( sizeof(FieldDataInfo) * numFields );
while( (ret = as_DBMGetNextRecordId( scanId, &recId, &numExistFields, fieldDataInfo) >= DBM_OK ) {
...
}