Graphisoft®

API Development KitVersion: 18

ACAPI_Notify_CatchLockableReservationChange

잠금 가능한 객체들의 예약 변경사항들에 대한 알림 핸들러를 세트합니다.

    GSErrCode  ACAPI_Notify_CatchLockableReservationChange (
        APILockChangeHandlerProc*        handlerProc,
        const GS::HashSet<API_Guid>*     filterLockablesInterestedOnly
    );

 

파라미터

handlerProc
[in] 지정한 이벤트에서 호출되는 알림 핸들러 함수입니다. 이 알림으로부터 해지하려면 NULL을 전달하십시오.
filterLockablesInterestedOnly
[in] 잠금 가능한 객체들의 guid들의 리스트입니다; 관심 있는 요소들의 범위를 제어하기 위한 선택적인 파라미터입니다. 만약 전달하면, 이 요소들에 대해서만 잠금 변경사항 알림들이 전송될 것입니다. 그 외에는 모든 잠금 변경사항들이 보고될 것입니다.

 

리턴 값

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

다른 공통 API 오류들에 대해서는 오류 코드들의 리스트를 보십시오.

 

설명

이 함수는 팀워크에서 잠금 가능한 객체들(예. 속성, 즐겨찾기, 모델 뷰 옵션)의 예약들이 변경되었을 때 알림을 받을 애드온을 구독하는 데 사용합니다. 일단 APILockChangeHandlerProc 함수 포인터가 전달되면, 애드온은 메모리에 로드된 채로 남아 있게 되고 알림을 수신합니다. 애드온이 더 이상 알림들을 필요로 하지 않는다면, 1번째 인자에 NULL 을 넣고 이 함수를 호출하여 알림 수신을 중단할 수 있습니다.

애드온이 지정한 요소들에 대해서만 관심을 갖고 있는 경우, filterLockablesInterestedOnly 파라미터에 요소 guid들의 리스트를 전달하여 이 요소들에 대해서만 집중하도록 세트할 수 있습니다. (현재 사용할 수 있는 잠금 가능한 객체 집합들의 리스트를 보십시오) 이 알림에 대해 동시에 하나의 핸들러 함수만 세트할 수 있다는 것을 참고하십시오. 즉, 서로 다른 잠금 가능한 객체들의 리스트들에 대하여 여러 개의 핸들러들을 세트할 수 없음을 의미합니다.

 

예제

APILockChangeHandlerProc의 예제 섹션을 보십시오.
API 개발 키트의 팀워크 제어알림 관리자 예제 프로젝트도 보십시오.

 

요구사항

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

 

참고사항

APILockChangeHandlerProc
ACAPI_Notify_CatchElementReservationChange
팀워크 제어
알림 관리자
API 함수