Graphisoft®

API Development KitVersion: 18

ACAPI_ListData_Get

listdata의 데이터를 가져옵니다.

    GSErrCode  ACAPI_ListData_Get (
        API_ListData*     listdata
    );

 

파라미터

listdata
[in/out] listdata의 파라미터들입니다. listdata의 타입, 집합의 인덱스, listdata의 인덱스는 listdata 헤더의 typeID, setIndex, index 필드들 안에 전달되어야 합니다. structure의 다른 필드들은 자동으로 채워집니다.

 

리턴 값

NoError
함수가 성공적으로 완료되었습니다.
APIERR_BADINDEX
유효하지 않은 listdata 인덱스가 전달되었습니다.
APIERR_BADID
유효하지 않은 listdata 타입이 전달되었습니다.
APIERR_DELETED
유효하지 않은 listdata가 제거되었습니다.

다른 공통 API 오류들에 대해서는 API 오류 문서를 보십시오.

 

설명

이 함수는 listdata 헤더의 typeID, setIndex, index 필드들에 의해 정의된 listdata를 가져오는 데 사용합니다. 주어진 listdata의 정보는 listdata의 필드들 안에 리턴됩니다.

이 함수는 ACAPI_ListData_GetLocal보다 빠릅니다.

listdata를 가져올 때, 적용 가능한 필드들을 채워야 합니다.

API_ListData_Head

setIndex

필수; >= 1 이어야 함

typeID

필수

index

필수

만약 당신이 descriptor를 가져오고 있다면, 마친 후에 name 핸들을 폐기하는 것을 잊지 마십시오.

 

예제

API_ListData  listdata;
GSErrCode     err;

BNZeroMemory (&listdata, sizeof (API_ListData));
listdata.header.setIndex = 1;
listdata.header.typeID   = API_DescriptorID;
listdata.header.index    = 1;

err = ACAPI_ListData_Get (&listdata);

BMKillHandle (&listdata.descriptor.name);

 

요구사항

버전: API 2.1 또는 이후
헤더: ACAPinc.h

 

참고사항

API_ListData,
ACAPI_ListData_GetLocal,
리스팅 관리자, API 함수