Edge Labels: cs_edge

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.0p0 Hot Tips

CONFIDENTIAL

CodeSecure Inc

Edge Labels: cs_edge_label.h

Defines a set of cs_edge_label operations.

Links
Defines
Functions
Function Descriptions

Defines

#define CS_EDGE_LABEL_H
#define CS_EDGE_LABEL_INL_H

Functions

cs_result	cs_edge_label_get_string ( cs_edge_label label, cs_string out_string, cs_size_t capacity_bytes, cs_size_t * bytes_needed ) Get the string representation of a cs_edge_label.
const char *	cs_edge_label_string ( cs_edge_label edge_label ) Get the string representation of a cs_edge_label.
cs_edge_label	cs_edge_label_true ( ) Get the "T" edge label.
cs_edge_label	cs_edge_label_false ( ) Get the "F" edge label.
cs_boolean	cs_edge_label_equal ( cs_edge_label el1, cs_edge_label el2 ) Equality test for cs_edge_label objects.
int	cs_edge_label_compare ( cs_edge_label el1, cs_edge_label el2 ) Compare two cs_edge_label objects.
cs_hash_t	cs_edge_label_hash ( cs_edge_label edge_label ) Hash function for cs_edge_label objects.
cs_edge_label	cs_edge_label_create ( cs_const_string s ) Create a new cs_edge_label with specified contents.
cs_boolean	cs_edge_label_is_null ( cs_edge_label edge_label ) Check: is the specified cs_edge_label null?
cs_edge_label	cs_edge_label_get_null ( ) Get a null cs_edge_label.

Function Descriptions

Function cs_edge_label_get_string

cs_result cs_edge_label_get_string (

cs_edge_label label,
cs_string out_string,
cs_size_t capacity_bytes,
cs_size_t * bytes_needed )

Get the string representation of a cs_edge_label.

Parameters

label	[in]	The cs_edge_label for which to find the string representation.
out_string	[out]	A user-allocated buffer to be populated with the string representation of label.
capacity_bytes	[in]	The capacity of out_string, measured in bytes.
bytes_needed	[out]	The number of bytes required to store the entire string representation of label.

Returns

CS_TRUNCATED if out_string is not large enough to hold the entire string representation of label (and so the string was truncated),
CS_SUCCESS otherwise.

Notes

Call this function with out_string NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire representation.

Function cs_edge_label_string

const char * cs_edge_label_string (

cs_edge_label edge_label )

Get the string representation of a cs_edge_label.

Parameters

edge_label

[in]

The cs_edge_label for which to return the string representation.

Returns

A pointer to a buffer containing the string representation of edge_label (as a char*). The buffer is only valid until another API function is invoked.

Notes

Do not modify or free the returned buffer.

This function entails less user overhead than cs_edge_label_get_string(), and so can be more convenient to use; the tradeoff is that the returned value is not under user control and has a constrained lifetime.

Function cs_edge_label_true

cs_edge_label cs_edge_label_true ( )

Get the "T" edge label.