JetGetTableIndexInfo 함수
적용 대상: Windows | Windows Server
JetGetTableIndexInfo 함수
JetGetTableIndexInfo 함수는 인덱스에 대한 정보를 검색합니다.
JET_ERR JET_API JetGetTableIndexInfo(
__in JET_SESID sesid,
__in JET_TABLEID tableid,
__in const tchar* szIndexName,
__out void* pvResult,
__in unsigned long cbResult,
__in unsigned long InfoLevel
);
매개 변수
sesid
API 호출에 사용할 데이터베이스 세션 컨텍스트입니다.
tableid
필요한 정보를 보유하는 인덱스가 포함된 데이터베이스 테이블입니다.
szIndexName
검색할 정보가 포함된 인덱스의 이름입니다.
pvResult
정보를 수신할 버퍼에 대한 포인터입니다. 필요한 형식을 유지하려면 버퍼를 정렬해야 합니다. 버퍼의 형식은 InfoLevel 매개 변수에 따라 달라집니다.
cbResult
pvResult 매개 변수에 전달된 버퍼의 크기(바이트)입니다.
InfoLevel
pvResult에 저장할 정보를 지정합니다. 유효한 값은
값 |
의미 |
---|---|
JET_IdxInfo |
pvResult 는 JET_INDEXLIST 구조체로 해석됩니다. 성공하면 JET_INDEXLIST 구조체는 인덱스에 대한 정보를 받습니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoLCID |
pvResult 는 LCID로 해석됩니다. 성공하면 LCID는 인덱스의 로캘 식별자를 보유합니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoList |
pvResult 는 JET_INDEXLIST 구조체로 해석됩니다. 성공하면 JET_INDEXLIST 구조체는 인덱스에 대한 정보를 받습니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoOLC |
JET_IdxInfoOLC 사용되지 않습니다. |
JET_IdxInfoResetOLC |
JET_IdxInfoResetOLC 더 이상 사용되지 않습니다. |
JET_IdxInfoSpaceAlloc |
pvResult 는 ULONG으로 해석됩니다. 성공하면 ULONG은 인덱스의 공간 사용량을 보유합니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoSysTabCursor |
JET_IdxInfoSysTabCursor 사용되지 않습니다. |
JET_IdxInfoLangid |
JET_IdxInfoLangid 더 이상 사용되지 않습니다. 대신 JET_IdxInfoLCID 및 LANGIDFROMLCID 매크로를 대신 사용합니다. |
JET_IdxInfoCount |
pvResult 는 ULONG으로 해석됩니다. 성공하면 ULONG은 지정된 테이블의 인덱스 수를 보유합니다. szIndexName 은 무시됩니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoVarSegMac |
pvResult 는 USHORT로 해석됩니다. 성공하면 USHORT는 인덱스를 만들 때 사용되는 cbVarSegMac 값을 보유합니다. cbVarSegMac에 대한 설명은 JET_INDEXCREATE 참조하세요. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoIndexId |
pvResult 는 JET_INDEXID 해석됩니다. 성공하면 JET_INDEXID 구조체는 인덱스에 대한 정보를 받습니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoKeyMost |
pvResult 는 USHORT로 해석됩니다. 성공하면 USHORT는 인덱스가 생성되었을 때 사용되는 cbKeyMost 값을 보유합니다. cbKeyMost에 대한 설명은 JET_INDEXCREATE 구조를 참조하세요. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. |
JET_IdxInfoCreateIndex |
pvResult 는 JET_INDEXCREATE 구조체로 해석됩니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. Windows 7: JET_IdxInfoCreateIndex Windows 7에 도입되었습니다. |
JET_IdxInfoCreateIndex2 |
pvResult 는 JET_INDEXCREATE2 구조체로 해석됩니다. 실패 시 pvBuffer 의 내용은 정의되지 않습니다. Windows 7: JET_IdxInfoCreateIndex2 Windows 7에 도입되었습니다. |
반환 값
이 함수는 다음 반환 코드 중 하나를 사용하여 JET_ERR 데이터 형식을 반환합니다. 가능한 ESE 오류에 대한 자세한 내용은 확장 가능한 스토리지 엔진 오류 및 오류 처리 매개 변수를 참조하세요.
반환 코드 |
설명 |
---|---|
JET_errSuccess |
작업이 성공적으로 완료되었습니다. |
JET_errIndexNotFound |
지정된 테이블에서 지정된 인덱스 를 찾을 수 없습니다. |
JET_wrnBufferTruncated |
pvResult로 전달된 버퍼가 너무 작습니다. 버퍼의 내용은 정의되지 않습니다. |
설명
JetGetIndexInfo 및 JetGetTableIndexInfo 는 인덱스에 대한 동일한 정보를 검색합니다. 차이점은 테이블이 지정되는 방식입니다. JetGetIndexInfo 에는 데이터베이스(dbid)와 테이블 이름(szTableName)이 필요한 반면 JetGetTableIndexInfo 에는 테이블 식별자(tableid)가 예상됩니다.
요구 사항
요구 사항 | 값 |
---|---|
클라이언트 |
Windows Vista, Windows XP 또는 Windows 2000 Professional이 필요합니다. |
서버 |
Windows Server 2008, Windows Server 2003 또는 Windows 2000 Server가 필요합니다. |
머리글 |
Esent.h에서 선언되었습니다. |
라이브러리 |
ESENT.lib를 사용합니다. |
DLL |
ESENT.dll 필요합니다. |
유니코드 |
JetGetTableIndexInfoW(유니코드) 및 JetGetTableIndexInfoA(ANSI)로 구현됩니다. |
참고 항목
JET_COLUMNID
JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JET_INDEXID
JetGetIndexInfo