APIEnv_GetToolBoxInfoID

툴박스의 현재 상태에 대한 정보를 리턴합니다.

    GSErrCode ACAPI_Environment (
        APIEnv_GetToolBoxInfoID,
        API_ToolBoxInfo*     toolBoxInfo,
        bool                 enableHidden
    );

 

파라미터

toolBoxInfo

[out] 툴박스에 대한 잡다한 정보입니다.

enableHidden

[in] 툴박스로부터 숨겨진 도구들도 포함합니다. 이 파라미터는 선택적입니다; 만약 2번째 파라미터에 NULL을 전달하면, 기본값은 false입니다.

 

리턴 값

NoError

함수가 성공적으로 완료되었습니다.

APIERR_BADPARS

tboxInfo가 NULL입니다.

APIERR_MEMFULL

메모리가 부족합니다.

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

 

설명

이 함수로 툴박스의 현재 상태를 쿼리할 수 있습니다. 서로 다른 설치된 항목들(외부 도구 역시 포함됨), 그리고 활성 툴박스 항목(활성 도구)에 대한 정보를 리턴합니다.

enableHidden flag는 ArchiCAD에게 숨겨진 툴박스 항목들도 포함시키라고 알려줍니다. 이것들은 툴박스에서 아무 아이콘을 갖고 있지 않은 도구들입니다. 마치 당신이 '실제' 도구들 중 하나를 선택한 것처럼 이것들을 사용하는 것은 ArchiCAD가 작동하는 상태로 들어갑니다. 이것의 좋은 예시는 Slab Accessory입니다.

 

예제

ACAPI_Environment (APIEnv_GetToolBoxInfoID, &toolBoxInfo, (void*) (Int32) true);

 

요구사항

버전: API 4.1 또는 이후

헤더: APIdefs_Environment.h

 

참고사항

API_ToolBoxInfo,
ACAPI_Environment,
API 함수