Ets_Output_Obj_Value_Get()

Abstract

Accesses an output value associated with a given object in the given context.

Syntax

Ets_Output_Obj_Value_Get (cxt_ptr, obj_hndl, output_value_name, value_pptr)
Argument Type Description
cxt_ptr EtsT_Output_Context * Output context of interest.
obj_hndl EtsT_Obj_Handle Object whose output data is being fetched.
output_value_name const char * Name of the output value to fetch.
value_pptr void * Area to hold a pointer to the requested output value. This memory must be valid for the type of data being output.

Return Type

EtsT_Output_Status

Status of the operation (see Details).

ets_api_output.h

Details

An output analysis of the required type (based on the context mode) must already have been run. Also, a valid registered value must exist for the output value requested.

The output value is placed in value_pptr. The caller owns the data. Complex data is copied to value_pptr. The caller must know what type of data to expect for the output value and pass an appropriate value. One common use is a getting string value, where you would pass a char** (the caller must deallocate this when no longer needed). Refer to the Examples for other uses.

If the value cache does not exist for the requested value, it is created and cached for faster access on subsequent requests.

The returned output status will be one of the following symbolic constants:

  • EtsC_Output_Status_SUCCESS—the operation was successful
  • EtsC_Output_Status_UNKNOWN_VALUE—output_value_name specifies an output value that cannot be handled or is unregistered
  • EtsC_Output_Status_NO_RESULTS—the analysis has not been run
  • EtsC_Output_Status_UNKNOWN_OBJECT—the analysis has been run, but the object does not have any results
  • EtsC_Output_Status_FAILURE—unspecified failure

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com