ACAPI_Element_GetElemList
주어진 타입의 요소들의 guid들을 가진 배열을 리턴합니다.
GSErrCode ACAPI_Element_GetElemList (
API_ElemTypeID typeID,
GS::Array<API_Guid>* elemList,
API_ElemFilterFlags filterBits = APIFilt_None,
API_ElemVariationID variationID = APIVarId_Generic
const API_Guid& renovationFilterGuid = APINULLGuid
);
파라미터
- typeID
- [in] 요소 타입 식별자입니다.
- elemList
- [out] 함수가 수집한 요소 guid들의 리스트입니다.
- filterBits
- [in] 필터링을 위해 사용한 flag들입니다. (ACAPI_Element_Filter 참고) 기본 값은
APIFilt_None입니다. - variationID
- [in] 객체들에 대한 선택적 variation ID입니다.
APIFilt_IsOfVariation과 조합해서 사용됩니다. 기본 값은APIVarId_Generic입니다. - renovationFilterGuid
- [in] 리노베이션 필터의 선택적 글로벌 유일 ID입니다.
APIFilt_IsVisibleByRenovation과 조합해서 사용됩니다. 기본 값은APINULLGuid입니다.
리턴 값
NoError- 함수가 성공적으로 완료되었습니다.
APIERR_BADPARS- elemList 포인터가
NULL입니다.
다른 공통 API 오류들에 대해서는 API 오류 문서를 보십시오.
설명
이 함수는 filterbits에 의해 정의된 기준과 일치하는 주어진 type과 variation의 요소를 통해 반복(iterate)하는 데 사용될 수 있습니다. (ACAPI_Element_Filter 표에 설명된 filterbits flag 값 참조)
타입에 관계없이 모든 요소를 가져오기 위해 API_ZombieElemID를 typeID로 전달할 수 있습니다.
예제
GS::Array<API_Guid> elemList;
ACAPI_Element_GetElemList (API_LineID, &elemList, APIFilt_OnActFloor);
DBPrintf ("number of lines on the active floor: %ld", elemList.GetSize ());
요구사항
- 버전: API 12 또는 이후
- 헤더: ACAPinc.h
