ACAPI_Notify_CatchChangeDefaults

주어진 요소 타입의 기본 설정값들이 변경된 경우 당신의 애드온이 알림을 받을지 여부를 등록 또는 등록 해제합니다.

    GSErrCode  ACAPI_Notify_CatchChangeDefaults (
        const API_ToolBoxItem*            elemType,
        APIDefaultsChangeHandlerProc*     handlerProc
    );

 

파라미터

elemType

[in] 당신의 애드온이 알림을 받아야 하는 요소의 타입을 지정합니다. 모든 타입의 요소의 기본 설정값들의 변경에 대한 알림을 받으려면 이 파라미터에 NULL을 전달하시면 됩니다.

handlerProc

[in] 이 요소 타입의 기본 설정값을 변경할 때 알림이 전송되면 호출되는 콜백 프로시저입니다. 여기에 NULL을 지정하는 것은 당신이 더 이상 알림이 필요하지 않다는 것을 의미합니다.

 

리턴 값

NoError

요청한 동작을 성공적으로 완료했습니다.

APIERR_BADID

elemType 파라미터가 유효하지 않은 typeID를 포함하고 있습니다.

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

 

설명

이 함수는 API 도구 애드온이 특정 타입의 요소의 기본 설정값의 변경을 캐치할 수 있게 해줍니다. 요소 타입의 기본 파라미터들 중 하나가 변경될 때마다 서버 애플리케이션은 예전에 이 이벤트에 대해 등록된 애드온이 제공한 콜백 프로시저를 호출합니다.

만약 더 이상 기본 설정값의 변경사항을 캐치할 필요가 없다면, handlerProc 파라미터에 NULL을 전달하여 요구하는 요소 타입에 대한 ACAPI_Notify_CatchChangeDefaults를 호출하여 등록을 해제하는 것을 기억하시기 바랍니다.

 

예제

// -----------------------------------------------------------------------------
// 기본값 변경 핸들러 함수
// -----------------------------------------------------------------------------
GSErrCode __ACENV_CALL ChangeDefaultsHandler (const API_ToolBoxItem *defElemType)

{
    char    msgStr[256];
    char    elemStr[32];

    if (GetElementTypeString (defElemType->typeID, elemStr))
        sprintf (msgStr, "%s element type defaults changed", elemStr);
    else
        sprintf (msgStr, "Unknown element type defaults changed");

    ACAPI_WriteReport (msgStr, false);

    return NoError;
}   // ChangeDefaultsHandler


// -----------------------------------------------------------------------------
// 애드온이 메모리에 로드된 후에 호출됨
// -----------------------------------------------------------------------------
GSErrCode    __ACENV_CALL    Initialize (void)

{
    // 모든 요소 타입들에 대한 기본 설정값에 대한 변경사항을 캐치
    GSErrCode err = ACAPI_Notify_CatchChangeDefaults (NULL, ChangeDefaultsHandler);

    return err;
}   // Initialize

 

요구사항

버전: API 4.1 또는 이후

헤더: ACAPinc.h

 

참고사항

API_ToolBoxItem, APIDefaultsChangeHandlerProc,
알림 관리자, API 함수