MI_Context_WriteProgress 함수(mi.h)

클라이언트에 진행률 메시지를 보냅니다.

구문

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_WriteProgress(
  [in] MI_Context    *context,
  [in] const MI_Char *activity,
  [in] const MI_Char *currentOperation,
  [in] const MI_Char *statusDescription,
       MI_Uint32     percentComplete,
       MI_Uint32     secondsRemaining
);

매개 변수

[in] context

요청 컨텍스트.

[in] activity

현재 작업을 나타내는 null로 끝나는 문자열입니다. 이 문자열은 클라이언트 UI 요청에 따라 지역화되어야 합니다( MI_Context_GetLocale 함수를 통해 검색됨).

[in] currentOperation

처리 중인 현재 작업을 나타내는 null로 끝나는 문자열입니다. 이 문자열은 클라이언트 UI 요청에 따라 지역화되어야 합니다.

[in] statusDescription

현재 상태 설명을 나타내는 null로 끝나는 문자열입니다. 이 문자열은 클라이언트 UI 요청에 따라 지역화되어야 합니다.

percentComplete

현재 완료율입니다. 0xffffffff 전달하면 완료율을 알 수 없음을 나타냅니다.

secondsRemaining

현재 작업을 완료하는 데 남은 예상 시간(초)입니다. 0xffffffff 전달하면 현재 작업을 완료하는 데 필요한 시간을 알 수 없음을 나타냅니다.

반환 값

함수 반환 코드를 지정하는 MI_Result 열거형의 값입니다. 다음 코드 중 하나일 수 있습니다.

설명

공급자는 이 함수를 호출하여 공급자가 얼마나 많은 작업을 수행하고 남은 시간을 나타냅니다. 클라이언트는 필요에 따라 비동기 콜백을 통해 이러한 메시지를 수신하도록 등록할 수 있습니다. 클라이언트가 이러한 메시지에 등록하지 않으면 서버는 메시지를 무시합니다. 이 함수는 장기 실행 작업에 특히 중요하므로 클라이언트는 작업이 응답을 중지했다고 생각하지 않습니다. 성능이 저하될 수 있으므로 너무 많은 진행률 메시지를 보내지 말고 클라이언트가 작업이 응답을 중지했다고 생각하지 않고 작업을 취소할 수 있을 만큼 자주 보냅니다. (0.5에서 10초 사이의 간격 범위는 합리적일 수 있습니다.) 또한 작업 중에 진행률 메시지가 표시되면 작업 시간 제한 기간을 다시 설정하여 작업이 작업 시간 제한 값보다 오래 지속될 수 있도록 합니다. 하지만 클라이언트가 이 콜백에 등록하지 않으면 시간 제한 값을 다시 설정할 방법이 없으므로 공급자가 진행률 메시지를 보내는 경우에도 시간이 초과할 수 있습니다.

요구 사항

참고 항목

MI_Context

MI_Context_GetLocale