sensitivity_type_cc.h File Reference

Contains C API definitions for sensitivity type. More...

#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/mip_macros_cc.h"
#include "mip_cc/result_cc.h"

Include dependency graph for sensitivity_type_cc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_sensitivity_type

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_SensitivityType_GetRulePackageIdSize(const mip_cc_sensitivity_type sensitivityType
	Gets size of buffer required to store a sensitivity type's rule package ID.
	MIP_CC_API (void) MIP_CC_ReleaseSensitivityType(mip_cc_sensitivity_type sensitivityType)
	Release resources associated with a sensitivity type.

Variables
char const int64_t int64_t *	actualIdSize
char const int64_t int64_t *	actualRulePackageSize
int64_t mip_cc_error *	errorInfo
char *	idBuffer
char const int64_t	idBufferSize
int64_t *	idSize
char *	rulePackageBuffer
char const int64_t	rulePackageBufferSize
int64_t *	rulePackageSize

Detailed Description

Contains C API definitions for sensitivity type.

Definition in file sensitivity_type_cc.h.

Typedef Documentation

mip_cc_sensitivity_type

typedef mip_cc_handle* mip_cc_sensitivity_type

Definition at line 41 of file sensitivity_type_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Gets size of buffer required to store a sensitivity type's rule package ID.

Gets a sensitivity type's rule package.

Gets size of buffer required to store a sensitivity type's rule package.

Gets a sensitivity type's rule package ID.

Parameters

sensitivityType	Sensitivity type
idSize	[Output] Size of buffer to hold rule package ID (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

sensitivityType	Sensitivity type
idBuffer	[Output] Buffer the ID will be copied into.
idBufferSize	Size (in number of chars) of the idBuffer.
actualIdSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If idBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualIdSize will be set to the minimum required buffer size.

Parameters

sensitivityType	Sensitivity type
rulePackageSize	[Output] Size of buffer to hold rule package (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

sensitivityType	Sensitivity type
rulePackageBuffer	[Output] Buffer the rule package will be copied into.
rulePackageBufferSize	Size (in number of chars) of the rulePackageBuffer.
actualRulePackageSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If rulePackageBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualRulePackageSize will be set to the minimum required buffer size.

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a sensitivity type.

Parameters

sensitivityType

Sensitivity type to be released

Variable Documentation

actualIdSize

char const int64_t int64_t* actualIdSize

Definition at line 82 of file sensitivity_type_cc.h.

actualRulePackageSize

char const int64_t int64_t* actualRulePackageSize

Definition at line 117 of file sensitivity_type_cc.h.

errorInfo

char const int64_t int64_t mip_cc_error* errorInfo

Definition at line 62 of file sensitivity_type_cc.h.

idBuffer

char* idBuffer

Definition at line 80 of file sensitivity_type_cc.h.

idBufferSize

char const int64_t idBufferSize

Definition at line 81 of file sensitivity_type_cc.h.

idSize

int64_t* idSize

Definition at line 61 of file sensitivity_type_cc.h.

rulePackageBuffer

char* rulePackageBuffer

Definition at line 115 of file sensitivity_type_cc.h.

rulePackageBufferSize

char const int64_t rulePackageBufferSize

Definition at line 116 of file sensitivity_type_cc.h.

rulePackageSize

int64_t* rulePackageSize

Definition at line 96 of file sensitivity_type_cc.h.