op_pk_fd_get_ptr()

Abstract

Obtains the value of a structure field in the specified packet; the field-of-interest is specified by a numeric index.

Syntax

op_pk_fd_get_ptr (pkptr, field_index, value_ptr)
Argument Type Description
pkptr Packet* pointer to the packet of interest.
[A pointer to a packet can be obtained from many KPs, including op_pk_create(), op_pk_create_fmt(), op_pk_copy(), op_pk_get(), op_subq_pk_access(), and op_subq_pk_remove().]
field_index int numeric index of the field-of-interest
[This value must be non-negative.]
value_ptr void** pointer to a variable to be filled in with the specified field's value

Return Type

Compcode

OPC_COMPCODE_FAILURE if the field is not obtained; OPC_COMPCODE_SUCCESS otherwise.

Example

	{
	/* variable declarations */
	Packet *pkptr; struct Custom_DS *ds_ptr;

	/* obtain an arriving packet */
	pkptr = op_pk_get (0);

	/* extract a data structure from a packet field */
	op_pk_fd_get_ptr (pkptr, 3, (void**)&ds_ptr);

	op_pk_destroy (pkptr);
	}

Details

This function removes the specified field from the packet. See the op_pk_fd_get() Details section for more information.

Purpose

Provides a mechanism to obtain the value of a packet's field. This KP works identically to op_pk_fd_get(), but applies only to object attributes of data type pointer. Refer to op_pk_fd_get() for full purpose and details.

Errors

Reference

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · 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