The result of an API operation. More...

Public Member Functions
csint64	as_integer () const
	Get an integer representation of `this`. More...

std::string	as_repr () const
	Get a representation of a result object that includes information useful for debugging. More...

std::string	as_string () const
	Get a simple string representation of a result object. More...

void	check () const
	Check `this`, throwing an exception or fatal error if it is not result::SUCCESS. More...

int	cmp (const result &other) const
	Comparison function for result, with respect to a stable overall ordering. More...

cs_hash_t	hash () const
	Hash function for result. More...

std::string	name () const
	Get the name of a result object. More...

Static Public Member Functions
static result	from_integer (csint64 _inner)
	Construct an instance from an integer representation. More...

Static Public Attributes
static const result	ABS_LOC_HAS_NO_INLINE_SOURCE
	The symbol has no inline source. More...

static const result	ABS_LOC_HAS_NO_PARENT
	The symbol has no structural parent. More...

static const result	ABS_LOC_HAS_NO_PDG
	The specified symbol is not contained by any procedure. More...

static const result	ABS_LOC_IS_GLOBAL
	The symbol is global, and the requested information is not relevant to globals. More...

static const result	ABS_LOC_NOT_FUNCTION
	The symbol passed to symbol::as_procedure() does not represent a function. More...

static const result	ABS_LOC_PDG_UNDEFINED
	The specified symbol represents an undefined function. More...

static const result	ACCESS_DENIED
	Access is denied. More...

static const result	AMC_IS_BOTTOM
	The AMC at given vertex is "bottom" (not reached). More...

static const result	AMC_NOT_AVAILABLE
	VSA is not available at given vertex, either because the given vertex is excluded from analysis, or analysis was disabled altogether. More...

static const result	CALLER_SHOULD_HANDLE
	The functionality is not handled at this layer, but should be handled by the caller. More...

static const result	DECLARATIONS_UNKNOWN
	There is no information about whether there are any declarations for the relevant symbol. More...

static const result	DEMANGLE_FAILED
	An attempt was made to demangle an invalid mangled name. More...

static const result	DISABLED
	The requested functionality is disabled. More...

static const result	DISCRETIONARY_ERROR_IO_PARTIAL_READ
	A read only partially succeeded, probably because of EOF. More...

static const result	ELEMENT_ALREADY_PRESENT
	The element already exists in the data structure. More...

static const result	ELEMENT_NOT_PRESENT
	The requested element of the data structure does not exist. More...

static const result	ERROR_AN_SDG_ALREADY_PRESENT
	Returned by project::load() if an SDG is already loaded. More...

static const result	ERROR_ANALYSIS_NOT_RUN
	Results of an AMC-based analysis were requested when the analysis was not run. More...

static const result	ERROR_ARGUMENT_CANNOT_BE_EMPTY
	Set when the user invokes a function with an empty string or ranges when empty ones are not allowed. More...

static const result	ERROR_ARGUMENT_CANNOT_BE_NULL
	Set when the user invokes a function with a NULL argument but the parameter is not allowed to be null. More...

static const result	ERROR_BASIC_BLOCKS_DIFFER
	The system cannot perform an incremental build because the setting of option -basic-blocks has changed. More...

static const result	ERROR_BINARIES_PRESENT_DIFFER
	The system cannot perform an incremental build because the presence of binary computation units has changed. More...

static const result	ERROR_CANNOT_FIND_PATH
	Set when an associated path cannot be found, such as with sfileinst::include_tree_path(). More...

static const result	ERROR_CFG_EDGES_DIFFER
	The system cannot perform an incremental build because the setting of option -cfg-edges has changed. More...

static const result	ERROR_CODESONAR_ONLY
	The feature is only available in CodeSonar and not in CodeSurfer. More...

static const result	ERROR_CODESURFER_ONLY
	The feature is only available in CodeSurfer and not in CodeSonar. More...

static const result	ERROR_COMPUNIT_HAS_NO_SFILEINST
	Set when the user invokes a function with a ::csfe_compunit that doesn't have a sfileinst, for example, the function csfe_diagstream_compunit_parse_error needs a ::csfe_compunit with a sfileinst so the parse error can be associated with a file. More...

static const result	ERROR_COMPUTE_SSA_DIFFER
	The system cannot perform an incremental build because the setting of option -compute-ssa has changed. More...

static const result	ERROR_COUNT_UNKNOWN
	Set when the number of errors encountered in compiling an SDG is completely unknown. More...

static const result	ERROR_COUNT_UNKNOWN_BUT_POSITIVE
	Set when errors were encountered in compiling an SDG is not known, but the exact number is unknown. More...

static const result	ERROR_CREATE_THREAD_FAILED
	Set when a thread cannot be created. More...

static const result	ERROR_DISALLOWED_SET_KIND
	The set kind is valid but not allowed for a particular operation. More...

static const result	ERROR_DISPLAY_USES_EXPRS_DIFFER
	The system cannot perform an incremental build because the setting of option -display-uses-exprs has changed. More...

static const result	ERROR_FATOBJ_STORE_DIRTY
	Set when the data store being opened is in an inconsistent state. More...

static const result	ERROR_FATOBJ_STORE_OPEN_FAILED
	Set when cannot open a data store file. More...

static const result	ERROR_FOREIGN_EXCEPTION
	An exception occured in a non-native language. More...

static const result	ERROR_FORK_FAILED
	fork() did not succeed. More...

static const result	ERROR_GET_COMPUTER_NAME_FAILED
	Set when the system function GetComputerName fails. More...

static const result	ERROR_GET_HOST_NAME_FAILED
	Set when the system function gethostname fails. More...

static const result	ERROR_GET_PW_UID_FAILED
	Set when the system function getpwuid fails. More...

static const result	ERROR_GET_USER_NAME_FAILED
	Set when the system function GetUserName fails. More...

static const result	ERROR_GRAN_MISMATCH
	Metric granularity does not match the operator. More...

static const result	ERROR_HAMMOCK_NUM_EXIT_EDGE_SETS
	Hammock w/ incorrect number of exit edge sets. More...

static const result	ERROR_IMMUTABLE_DATA_STRUCTURE
	Set when an attempt is made to mutate an immutable data structure. More...

static const result	ERROR_INCOMPATIBLE_VERSION
	Error msg for incompatible version of Symantec Endpoint Protection, which causes kernel deadlock w/ hookcs driver. More...

static const result	ERROR_INVALID_ABS_LOC_KIND
	Set when the user invokes a function with an invalid symbol_kind parameter. More...

static const result	ERROR_INVALID_ARGUMENT
	An argument is not a valid instance of the required type. More...

static const result	ERROR_INVALID_AST_CLASS
	Set when the user invokes a function with an invalid ast_class parameter. More...

static const result	ERROR_INVALID_ATTRIBUTE
	The attribute is invalid. More...

static const result	ERROR_INVALID_COLORING_ID
	Reserved for future use. More...

static const result	ERROR_INVALID_FAMILY
	Set when the user invokes a function with an invalid ast_family parameter. More...

static const result	ERROR_INVALID_FILTER_PDG_DIRECTIVE
	A depfilter_procedure_directive is not valid. More...

static const result	ERROR_INVALID_FILTER_PDG_VERTEX_DIRECTIVE
	A depfilter_point_directive is not valid. More...

static const result	ERROR_INVALID_FLAG
	Set when the user invokes a function with an invalid flag parameter. More...

static const result	ERROR_INVALID_KIND
	Set when the user invokes a function with an invalid kind parameter. More...

static const result	ERROR_INVALID_LANGUAGE
	Set when the user invokes a function with an invalid language parameter. More...

static const result	ERROR_INVALID_LINE
	Set when the user invokes a function with an invalid line_number parameter. More...

static const result	ERROR_INVALID_LINE_POSITION
	The position of the start of a line in a source file could not be determined. More...

static const result	ERROR_INVALID_LINK_TYPE
	Set when the user invokes a function with an invalid ::csfe_link_type parameter. More...

static const result	ERROR_INVALID_OFFSET
	Set when a file offset is not within the bounds of the file. More...

static const result	ERROR_INVALID_OPERATOR
	The operator is invalid. More...

static const result	ERROR_INVALID_PDG_EDGE_KIND
	When user invokes a function with an invalid pdg_edge_kind. More...

static const result	ERROR_INVALID_PDG_KIND
	When user invokes a function with an invalid procedure_kind, probably as part of a parameter. More...

static const result	ERROR_INVALID_PHASE_FOR_OPERATION
	The operation is not valid during this phase of the analysis. More...

static const result	ERROR_INVALID_PS_ENUM
	The predsucc_filter_directive is invalid. More...

static const result	ERROR_INVALID_SDG
	Returned by project::load() if it is passed an invalid SDG file. More...

static const result	ERROR_INVALID_SDG_STORE
	Returned by project::load() if it is passed an invalid store file. More...

static const result	ERROR_INVALID_SEEK_RETURN_RANGE
	The specified range spans across multiple physical source files, is out of the range, or start>end. More...

static const result	ERROR_INVALID_SET_KIND
	Set when the user invokes a function with an invalid set_kind parameter. More...

static const result	ERROR_INVALID_SFID
	Set if an invalid sfileinst is given as a parameter, such as to sfileinst::name(). More...

static const result	ERROR_INVALID_SFID_OR_LINE
	Set when either a relevant source file was deleted or changed or the given line number does not exist within the file. More...

static const result	ERROR_INVALID_SFID_STRING
	Set if a std::string that is not a well-formed sfid is passed to cs_string_to_sfid() (C API only). More...

static const result	ERROR_INVALID_SLAVE_OPERATION
	The operation is not valid from a slave process. More...

static const result	ERROR_INVALID_SYNTAX_KIND
	Set when an invalid syntax_kind is specified. More...

static const result	ERROR_INVALID_TOKDEF_KIND
	Reserved for future use. More...

static const result	ERROR_INVALID_TYPE
	Set when an invalid type is requested. More...

static const result	ERROR_INVALID_UNITLINE
	The compilation unit does not contain the specified line. More...

static const result	ERROR_INVALID_VERTEX_KIND
	When user invokes a function with an invalid point_kind. More...

static const result	ERROR_INVALID_VERTEX_SYNTAX_ELEMENT
	When user invokes a function with an invalid point_syntax_element. More...

static const result	ERROR_INVALID_VERTEX_SYNTAX_KIND
	When user invokes a function with an invalid point_syntax_kind. More...

static const result	ERROR_IO_CLOSE
	Set when cannot close a file (close/CloseHandle). More...

static const result	ERROR_IO_FLUSH
	Set when a flush operation (fsync/FlushFileBuffers) fails. More...

static const result	ERROR_IO_GET_EOF
	Set when a attempt to retrieve EOF fails (lseek/GetFileSizeEx). More...

static const result	ERROR_IO_GET_POSITION
	Set when cannot get position of file pointer (lseek/SetFilePointerEx failed). More...

static const result	ERROR_IO_LOCK
	Set when a file is locked by another process. More...

static const result	ERROR_IO_LOCKED_BY_OTHER
	Set when an attempt to remotely open a file for writing when the remote has the file open in read-only mode. More...

static const result	ERROR_IO_MOVE_EOF
	Set when cannot move EOF (ftruncate/SetEndOfFile). More...

static const result	ERROR_IO_OPEN_FILE_LOCK_FAILURE
	Set when fcntl(f, F_SETLK, &lock) fails for a reason besides lock contention. More...

static const result	ERROR_IO_OPEN_FILE_TO_READ
	Set when cannot open a file to read. More...

static const result	ERROR_IO_OPEN_FILE_TO_WRITE
	Set when cannot open a file to write. More...

static const result	ERROR_IO_READ
	Set when a read operation (read/ReadFile) fails. More...

static const result	ERROR_IO_READ_BAD_CHECKSUM
	The checksum did not match. More...

static const result	ERROR_IO_READ_PAST_EOF
	Set when an attempt is made to read past EOF. More...

static const result	ERROR_IO_READ_TOO_MUCH
	Set when a read operation (read/ReadFile) reads more bytes than were requested. More...

static const result	ERROR_IO_READ_ZERO
	Set when a read operation (read/ReadFile) reads zero bytes. More...

static const result	ERROR_IO_RENAME
	Set when a file cannot be renamed. More...

static const result	ERROR_IO_SEEK
	Set when a seek operation (lseek/SetFilePointerEx) fails. More...

static const result	ERROR_IO_SEEK_PAST_EOF
	Set when an attempt is made to seek past EOF. More...

static const result	ERROR_IO_SEEK_TO_EOF
	Set when cannot seek to EOF (lseek). More...

static const result	ERROR_IO_STAT
	Set when cannot stat a file. More...

static const result	ERROR_IO_WRITE
	Set when a write operation (write/WriteFile) fails. More...

static const result	ERROR_IO_WRITE_PAST_EOF
	Set when an attempt is made to write past EOF. More...

static const result	ERROR_IO_WRITE_TO_READ_ONLY
	Set when an attempt is made to write to a read only resource. More...

static const result	ERROR_IO_WRITE_TOO_MUCH
	Set when a write operation (write/WriteFile) writes more bytes than were requested. More...

static const result	ERROR_IO_WRITE_ZERO
	Set when a write operation (write/WriteFile) writes zero bytes. More...

static const result	ERROR_LANGUAGE_NOT_FOUND
	Set in compunit::get_language() if the programming language cannot be determined. More...

static const result	ERROR_LAUNCHD_NO_HOME
	A remote analysis was requested on a launchd that was never specified a home directory via -launchd-home. More...

static const result	ERROR_LAUNCHD_QUOTA_EXCEEDED
	A remote analysis was requested on a launchd that didn't have enough remaining quota space to handle the incoming .prj_files. More...

static const result	ERROR_LICENSE_EXPIRED
	The license has expired since being checked out. More...

static const result	ERROR_LICENSE_LOCK_LOST
	The lock on the license was lost, most likely because it was deleted or moved. More...

static const result	ERROR_LICENSE_VERIFICATION_FAILED
	The license is corrupt; perhaps it was not transcribed correctly. More...

static const result	ERROR_MISMATCH
	Set when a value or ID does not match expectations. More...

static const result	ERROR_NEGATIVE_THRESHOLD
	Set when a function is given a negative threshold. More...

static const result	ERROR_NO_BACKWARD_CFG_EDGES
	Set when a function is called that depends on backward CFG edges but the current project was built without them. More...

static const result	ERROR_NO_BASIC_BLOCKS
	Set when a function is called that depends on basic blocks but the current project was built without them. More...

static const result	ERROR_NO_BUILDER_LICENSE
	No builder licenses are available. More...

static const result	ERROR_NO_CFG_EDGES
	Set when a function is called that depends on CFG edges but the current project was built without them. More...

static const result	ERROR_NO_CONTAINER
	Reserved for future use. More...

static const result	ERROR_NO_CONTROL_DEPENDENCE
	Set when a function is called that depends on control dependence but the current project was built with -control-dependence no. More...

static const result	ERROR_NO_CONTROL_DEPENDENCE_LABELS
	Set when a function is called that depends on control dependence labels but the current project was built with -retain-control-dependence-labels no. More...

static const result	ERROR_NO_DATA_DEPENDENCE
	Set when a function is called that depends on data dependence but the current project was built with -data-dependence no. More...

static const result	ERROR_NO_DECL_VERTICES
	When a function is called that depends on declaration vertices but the current project was built without it. More...

static const result	ERROR_NO_DEPENDENCES
	Set when a function is called that depends on dependence edges but the current project was built without them. More...

static const result	ERROR_NO_EXCEPTIONS_OR_ABNORMAL_EXITS
	The project was not built with support for exceptions or abnormal exits, so the requested information is unavailable. More...

static const result	ERROR_NO_GMOD
	Set when a function is called that depends on gmod but the current project was built with -compute-gmod no. More...

static const result	ERROR_NO_INTER_CFG_EDGES
	Set when a function is called that depends on interprocedural CFG edges but the current project was built without them. More...

static const result	ERROR_NO_LICENSE
	Set if a C API function is called without first checking out the license. More...

static const result	ERROR_NO_POINTER_ANALYSIS
	Set when a function is called that depends on pointer analysis but the current project was built without it. More...

static const result	ERROR_NO_SCC
	Set when a function is called that depends on strongly connected components, but the current project was built without summary edges (which enable SCCs). More...

static const result	ERROR_NO_SUB_OBJECT_ABS_LOCS
	Set when a function is called that depends on subordinate abs locs (i.e., field abs locs) but the current project was built without them. More...

static const result	ERROR_NO_SUCH_PDG_HAMMOCK
	No such pdg hammock. More...

static const result	ERROR_NO_SUMMARY_EDGES
	Set when a function is called that depends on summary edges, but the current project was built without them. More...

static const result	ERROR_NO_USE_DEF_SETS
	Set when a function is called that depends on CFG sets but the current project was built without them. More...

static const result	ERROR_NONINCR_TO_INCR
	The system cannot perform an incremental build because the previous build was with INCREMENTAL_BUILD=No and so build-time temporary data was not retained for future builds. More...

static const result	ERROR_NORM_DISJUNCTIVES_DIFFER
	The system cannot perform an incremental build because the setting of option -norm-disjunctives has changed. More...

static const result	ERROR_NOT_A_CALL_SITE
	The relevant vertex is not a call-site. More...

static const result	ERROR_NOT_A_GLOBAL
	Set when the user invokes a function with a ::csfe_symbol that's not a global when the function only handles global symbol. More...

static const result	ERROR_NOT_AN_ACTUAL_IN
	The relevant vertex is not an actual in. More...

static const result	ERROR_NOT_AN_ACTUAL_OUT
	The relevant vertex is not an actual out. More...

static const result	ERROR_NOT_IN_BATCH_MODE
	Internal use only. More...

static const result	ERROR_NOT_INITIALIZED
	Set when the user invokes a function in a module before the module is ready. More...

static const result	ERROR_OUT_OF_MEMORY
	Set when an allocation fails. More...

static const result	ERROR_OVERFLOW
	Set when a value is too large or too small. More...

static const result	ERROR_PARAM_EVAL_ORDER_DIFFER
	The system cannot perform an incremental build because the setting of configuration parameter PARAMETER_EVALUATION_ORDER has changed. More...

static const result	ERROR_PARAMETER_TOO_LARGE
	A parameter to the function exceeded the maximum allowable value. More...

static const result	ERROR_PDG_VERTEX_TO_AST_MAPPING_DIFFER
	The system cannot perform an incremental build because the setting of option -retain-pdg-vertex-to-ast-mapping has changed. More...

static const result	ERROR_PI_NODES_DIFFER
	The system cannot perform an incremental build because the setting of option -pi-nodes has changed. More...

static const result	ERROR_RANGE_CANNOT_BE_EMPTY
	Set when the user invokes a function with an empty range when empty ones are not allowed. More...

static const result	ERROR_RETAIN_UNNORMALIZED_C_AST_DIFFER
	The system cannot perform an incremental build because the setting of configuration parameter RETAIN_UNNORMALIZED_C_AST has changed. More...

static const result	ERROR_SDG_NOT_PRESENT
	Set if the project is unbuilt (incomplete or non-existent SDG file) and a function is called that traverses the SDG. More...

static const result	ERROR_UID_NOT_FOUND
	No compilation unit exists for the specified compunit. More...

static const result	ERROR_UNKNOWN_ABS_LOC_KIND
	The kind of the symbol could not be determined. More...

static const result	FILTERED_OUT
	An element was not submitted to the hub because it matched a configuration file `discard` rule. More...

static const result	FRONT_END_DOES_NOT_IMPLEMENT_FEATURE
	The front end (parser) for this IR does not implement the requested feature. More...

static const result	GENERATED_COMPILATION
	The specified compunit corresponds to a compilation generated in the back end or by ir_factory::make_compunit(). More...

static const result	INCOMPATIBLE_ARGUMENTS
	The command-line arguments provided are incompatible. More...

static const result	INTERNAL_ERROR_ABS_LOC_FUNCTION_TO_PDG_NO_PDG
	Internal use only. More...

static const result	INTERNAL_ERROR_ABS_LOC_SET_CLOSE
	Internal use only. More...

static const result	INTERNAL_ERROR_AIN_NO_CALL
	Internal use only. More...

static const result	INTERNAL_ERROR_BAD_ABS_LOC_KIND
	Internal use only. More...

static const result	INTERNAL_ERROR_BAD_ABS_LOC_UID
	Internal use only. More...

static const result	INTERNAL_ERROR_BAD_FORMAL
	Internal use only. More...

static const result	INTERNAL_ERROR_BB_SET_CLOSE
	Internal use only. More...

static const result	INTERNAL_ERROR_CONNECTION_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_CREATESERVICE_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_DELETESERVICE_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_DRVHOOKCS_ACTIVATE
	Internal use only. More...

static const result	INTERNAL_ERROR_DRVHOOKCS_CONFIGURE
	Internal use only. More...

static const result	INTERNAL_ERROR_DRVHOOKCS_FLTLIB_GETPROCADDRESS
	Internal use only. More...

static const result	INTERNAL_ERROR_DRVHOOKCS_FLTLIB_LOADLIBRARY
	Internal use only. More...

static const result	INTERNAL_ERROR_DRVHOOKCS_INCOMPATIBLE_VERSION
	Internal use only. More...

static const result	INTERNAL_ERROR_DRVHOOKCS_SINGLE_PARSE_VERSION
	Internal use only. More...

static const result	INTERNAL_ERROR_GET_ISET
	Internal use only. More...

static const result	INTERNAL_ERROR_GET_LENGTH
	Internal use only. More...

static const result	INTERNAL_ERROR_GET_NTDLL_BASE_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_GETCURRENTDIRECTORY_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_GETCWD_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_IP_MAP_COMPUTE_FAIL
	Internal use only. More...

static const result	INTERNAL_ERROR_IP_SET_CLOSE
	Internal use only. More...

static const result	INTERNAL_ERROR_KERNEL_OBJECT_NAME_UNKNOWN
	Internal use only. More...

static const result	INTERNAL_ERROR_MULTIBYTETOWIDECHAR
	Internal use only. More...

static const result	INTERNAL_ERROR_NO_VALUESET_INTERFACE
	Internal use only. More...

static const result	INTERNAL_ERROR_NULL_ABS_LOC_FIELD
	Internal use only. More...

static const result	INTERNAL_ERROR_NULL_ABS_LOC_FIELDS
	Internal use only. More...

static const result	INTERNAL_ERROR_NULL_INL_TARGET
	Internal use only. More...

static const result	INTERNAL_ERROR_NULL_INL_TARGETS
	Internal use only. More...

static const result	INTERNAL_ERROR_NULL_LAST_VERTEX
	Internal use only. More...

static const result	INTERNAL_ERROR_NULL_LAST_VERTEX_2
	Internal use only. More...

static const result	INTERNAL_ERROR_OPENSCMANAGER_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_OPENSERVICE_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_PDG_CALL_NO_CALLEE
	Internal use only. More...

static const result	INTERNAL_ERROR_PDG_CALL_NO_CALLEE_2
	Internal use only. More...

static const result	INTERNAL_ERROR_PDG_CALL_NO_CALLEE_3
	Internal use only. More...

static const result	INTERNAL_ERROR_PDG_MISSING
	Internal use only. More...

static const result	INTERNAL_ERROR_PDG_MISSING_02
	Internal use only. More...

static const result	INTERNAL_ERROR_PDGV_SET_CLOSE
	Internal use only. More...

static const result	INTERNAL_ERROR_QUERYSERVICESTATUS_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_REGISTRY_WRITE_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_SERVICE_DID_NOT_START
	Internal use only. More...

static const result	INTERNAL_ERROR_SERVICE_UNEXPECTED_STATE
	Internal use only. More...

static const result	INTERNAL_ERROR_STARTSERVICE_FAILED
	Internal use only. More...

static const result	INTERNAL_ERROR_TERMINAL_SERVER_NOT_OK
	Internal use only. More...

static const result	INTERNAL_ERROR_TRY_AGAIN_LATER
	Internal use only. More...

static const result	INTERNAL_ERROR_U2S_MISSING_TMPDIR
	Internal use only. More...

static const result	INTERNAL_ERROR_UID_SFID_HANDLES_MISSING_TMPDIR
	Internal use only. More...

static const result	INTERNAL_ERROR_UID_SFID_HANDLES_NOT_DEFINED
	Internal use only. More...

static const result	INTERNAL_ERROR_UID_SFID_HANDLES_NOT_LIST
	Internal use only. More...

static const result	INTERNAL_ERROR_UID_SFID_HANDLES_NOT_PAIR
	Internal use only. More...

static const result	INTERNAL_ERROR_UID_SFID_HANDLES_NOT_SFID
	Internal use only. More...

static const result	INTERNAL_ERROR_UID_SFID_HANDLES_NOT_SHANDLE
	Internal use only. More...

static const result	INTERNAL_ERROR_UNEXPECTED_MESSAGE
	Internal use only. More...

static const result	INTERNAL_ERROR_UNEXPECTED_RESPONSE_CODE
	Internal use only. More...

static const result	INTERNAL_ERROR_UNFAMILIAR_SYSCALL
	Internal use only. More...

static const result	INTERNAL_ERROR_UNION_P_FAILS
	Internal use only. More...

static const result	INTERNAL_ERROR_UNKNOWN
	This error should never be seen by an API client, even when something is horribly wrong. More...

static const result	INTERNAL_ERROR_VALUESET_NOT_FOUND
	Internal use only. More...

static const result	INTERNAL_STOP_TRAVERSAL
	Stop traversal. More...

static const result	INVALID_DATA_FORMAT
	The data was not in a valid format for the operation. More...

static const result	METRIC_NOT_COMPUTED
	The requested metric value was not computed. More...

static const result	MODULE_IR_NOT_AVAILABLE
	The requested information is not available for the given module, because the module is summarized. More...

static const result	NO_BOUNDS
	The requested element has no upper or lower bound. More...

static const result	NO_LOWER_BOUND
	The requested element has no lower bound. More...

static const result	NO_POSITION
	The compilation does not have any position information, for example because it is generated by the back end. More...

static const result	NO_PRIMARY_DECLARATION
	No primary declaration found for a symbol. More...

static const result	NO_REPRESENTED_STRING
	Returned by symbol::represented_string() when the string associated with the specified symbol cannot be found. More...

static const result	NO_SOURCE_CORRESPONDENCE
	An IR element does not correspond to any source code so a request for coordinates in source code (e.g., a line number) has failed. More...

static const result	NO_SUCH_BASIC_BLOCK
	Returned by procedure::retrieve_basic_block() when there is no such basic block. More...

static const result	NO_SUCH_PDG
	Returned by project::find_procedure() when there is no such pdg. More...

static const result	NO_SUCH_PDG_VERTEX
	Returned by procedure::retrieve_point() when there is no such vertex. More...

static const result	NO_UPPER_BOUND
	The requested element has no upper bound. More...

static const result	NOT_A_MANGLED_NAME
	An attempt was made to demangle a name that is not a mangled name. More...

static const result	NOT_IMPLEMENTED
	The functionality is not implemented for the provided inputs. More...

static const result	NOT_MACHINE_CODE
	The given UID is not a machine-code module. More...

static const result	ON_BAD_FILE_SYSTEM
	The file is on a file system that could cause reliability or performance problems. More...

static const result	OUT_OF_ELEMENTS
	An iterator ran out of elements. More...

static const result	PATH_INFEASIBLE
	The path in question is infeasible. More...

static const result	PDG_HAS_NO_NORMAL_EXIT
	The procedure has no normal exit vertex. More...

static const result	PDG_HAS_NO_NORMAL_RETURN
	The procedure has no normal return vertex. More...

static const result	PDG_IS_UNDEFINED
	The procedure represents an undefined function. More...

static const result	PDG_NOT_FOUND
	A procedure with the given name cannot be found. More...

static const result	PDG_VERTEX_HAS_NO_SYMBOL
	The point has no symbol. More...

static const result	PDG_VERTEX_HAS_ZERO_OR_MULTIPLE_PREDECESSORS
	The point does not have exactly one predecessor. More...

static const result	PDG_VERTEX_HAS_ZERO_OR_MULTIPLE_SUCCESSORS
	The point does not have exactly one successor. More...

static const result	PDGV_NOT_IN_BASIC_BLOCK
	A basic block related function (such as point::get_basic_block() ) is invoked on a point that is not part of a basic block. More...

static const result	REPLACED
	The key already exists in the data structure, the old element was replaced with the new one. More...

static const result	SSL_CERTIFICATE_ERROR
	One of several issues with the server's TLS/SSL certificate make it invalid. More...

static const result	SSL_CERTIFICATE_HOSTNAME_MISMATCH
	The server's TLS/SSL certificate indicates via the Common Name field that it is intended for a different hostname than appears in the URL being used. More...

static const result	SUCCESS
	The function was successful. More...

static const result	TIMEOUT
	A time out occurred. More...

static const result	TRUNCATED
	A user-allocated buffer was too small so the result was truncated. More...

static const result	VERTEX_HAS_NO_RANK
	The point is not a {formal,actual}-{in,out} or a global-{formal,actual}-{in,out} and, therefore, has no rank. More...

Related Functions
(Note that these are not member functions.)
bool	operator!= (const result &a, const result &b)
	Inequality operator for result. More...

bool	operator< (const result &a, const result &b)
	Less-than operator for result. More...

std::ostream &	operator<< (std::ostream &out, const result &a)
	Print a representation of a result object to the specified stream. More...

bool	operator<= (const result &a, const result &b)
	Less-than-or-equal operator for result. More...

bool	operator== (const result &a, const result &b)
	Equality operator for result. More...

bool	operator> (const result &a, const result &b)
	Greater-than operator for result. More...

bool	operator>= (const result &a, const result &b)
	Greater-than-or-equal operator for result. More...

Detailed Description

The result of an API operation.

The 'internal' errors INTERNAL_ERROR_* should never occur if CodeSurfer/CodeSonar is functioning correctly and well-formed inputs have been provided to the function in question. If you see such an error but do not think you have introduced memory errors or the like, then please report any details about what caused the error to CodeSecure support.

Member Function Documentation

◆ as_integer()

csint64 cs::result::as_integer ( ) const

inline

Get an integer representation of this.

Returns: An integer suitable for use with from_integer(). Invariant: For result x, result.from_integer(x.as_integer()) == x

◆ as_repr()

std::string cs::result::as_repr ( ) const

inline

Get a representation of a result object that includes information useful for debugging.

Returns: The string representation.

◆ as_string()

std::string cs::result::as_string ( ) const

inline

Get a simple string representation of a result object.

Returns: The string representation.

◆ check()

void cs::result::check ( ) const

inline

Check this, throwing an exception or fatal error if it is not result::SUCCESS.

Returns: void

If this is equal to result::SUCCESS, check() returns normally.

Otherwise, behavior depends on whether exception handling is enabled.

If exception handling is enabled, this is thrown as an exception.
If exception handling is disabled, a fatal error occurs. The error message explains the problem represented by this.

Exceptions

cs::result Any result value except result::SUCCESS, with value matching this.

◆ cmp()

int cs::result::cmp ( const result & other ) const

inline

Comparison function for result, with respect to a stable overall ordering.

Parameters

other The result object to compare against.

Returns

An integer N such that:

N==0 if the two objects compare equal
N<0 if this < other
N>0 if this > other

◆ from_integer()

static result cs::result::from_integer ( csint64 _inner )

inlinestatic

Construct an instance from an integer representation.

Parameters

[in] _inner The integer representation, as returned by as_integer(). Invariant: For result x, result.from_integer(x.as_integer()) == x

Exceptions

cs::result::ERROR_INVALID_ARGUMENT if _inner is not a valid integer representation for a result instance.

◆ hash()

cs_hash_t cs::result::hash ( ) const

inline

Hash function for result.

◆ name()

std::string cs::result::name ( ) const

inline

Get the name of a result object.

Returns: The name.

Friends And Related Function Documentation

◆ operator!=()

bool operator!=	(	const result &	a,
		const result &	b
	)

Parameters

[in]	a	The result object to compare.
[in]	b	The result object to compare against.

Returns: false if a and b are equal according to result::cmp(), true otherwise.

◆ operator<()

bool operator<	(	const result &	a,
		const result &	b
	)

Parameters

[in]	a	The result object to compare.
[in]	b	The result object to compare against.

Returns: true if a < b according to result::cmp() , false otherwise.

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	out,
		const result &	a
	)

Parameters

[in]	out	The stream to print to.
[in]	a	The result object to print.

Returns: void

◆ operator<=()

bool operator<=	(	const result &	a,
		const result &	b
	)

Parameters

[in]	a	The result object to compare.
[in]	b	The result object to compare against.

Returns: true if a <= b according to result::cmp() , false otherwise.

◆ operator==()

bool operator==	(	const result &	a,
		const result &	b
	)

Parameters

[in]	a	The result object to compare.
[in]	b	The result object to compare against.

Returns: true if a and b are equal according to result::cmp(), false otherwise.

◆ operator>()

bool operator>	(	const result &	a,
		const result &	b
	)

Parameters

[in]	a	The result object to compare.
[in]	b	The result object to compare against.

Returns: true if a > b according to result::cmp() , false otherwise.

◆ operator>=()

bool operator>=	(	const result &	a,
		const result &	b
	)

Parameters

[in]	a	The result object to compare.
[in]	b	The result object to compare against.

Returns: true if a >= b according to result::cmp() , false otherwise.

Member Data Documentation

◆ ABS_LOC_HAS_NO_INLINE_SOURCE

const result cs::result::ABS_LOC_HAS_NO_INLINE_SOURCE

static

The symbol has no inline source.

◆ ABS_LOC_HAS_NO_PARENT

const result cs::result::ABS_LOC_HAS_NO_PARENT

static

The symbol has no structural parent.

◆ ABS_LOC_HAS_NO_PDG

const result cs::result::ABS_LOC_HAS_NO_PDG

static

The specified symbol is not contained by any procedure.

◆ ABS_LOC_IS_GLOBAL

const result cs::result::ABS_LOC_IS_GLOBAL

static

The symbol is global, and the requested information is not relevant to globals.

◆ ABS_LOC_NOT_FUNCTION

const result cs::result::ABS_LOC_NOT_FUNCTION

static

The symbol passed to symbol::as_procedure() does not represent a function.

◆ ABS_LOC_PDG_UNDEFINED

const result cs::result::ABS_LOC_PDG_UNDEFINED

static

The specified symbol represents an undefined function.

◆ ACCESS_DENIED

const result cs::result::ACCESS_DENIED

static

Access is denied.

◆ AMC_IS_BOTTOM

const result cs::result::AMC_IS_BOTTOM

static

The AMC at given vertex is "bottom" (not reached).

◆ AMC_NOT_AVAILABLE

const result cs::result::AMC_NOT_AVAILABLE

static

VSA is not available at given vertex, either because the given vertex is excluded from analysis, or analysis was disabled altogether.

◆ CALLER_SHOULD_HANDLE

const result cs::result::CALLER_SHOULD_HANDLE

static

The functionality is not handled at this layer, but should be handled by the caller.

◆ DECLARATIONS_UNKNOWN

const result cs::result::DECLARATIONS_UNKNOWN

static

There is no information about whether there are any declarations for the relevant symbol.

◆ DEMANGLE_FAILED

const result cs::result::DEMANGLE_FAILED

static

An attempt was made to demangle an invalid mangled name.

◆ DISABLED

const result cs::result::DISABLED

static

The requested functionality is disabled.

◆ DISCRETIONARY_ERROR_IO_PARTIAL_READ

const result cs::result::DISCRETIONARY_ERROR_IO_PARTIAL_READ

static

A read only partially succeeded, probably because of EOF.

◆ ELEMENT_ALREADY_PRESENT

const result cs::result::ELEMENT_ALREADY_PRESENT

static

The element already exists in the data structure.

◆ ELEMENT_NOT_PRESENT

const result cs::result::ELEMENT_NOT_PRESENT

static

The requested element of the data structure does not exist.

◆ ERROR_AN_SDG_ALREADY_PRESENT

const result cs::result::ERROR_AN_SDG_ALREADY_PRESENT

static

Returned by project::load() if an SDG is already loaded.

◆ ERROR_ANALYSIS_NOT_RUN

const result cs::result::ERROR_ANALYSIS_NOT_RUN

static

Results of an AMC-based analysis were requested when the analysis was not run.

◆ ERROR_ARGUMENT_CANNOT_BE_EMPTY

const result cs::result::ERROR_ARGUMENT_CANNOT_BE_EMPTY

static

Set when the user invokes a function with an empty string or ranges when empty ones are not allowed.

◆ ERROR_ARGUMENT_CANNOT_BE_NULL

const result cs::result::ERROR_ARGUMENT_CANNOT_BE_NULL

static

Set when the user invokes a function with a NULL argument but the parameter is not allowed to be null.

◆ ERROR_BASIC_BLOCKS_DIFFER

const result cs::result::ERROR_BASIC_BLOCKS_DIFFER

static

The system cannot perform an incremental build because the setting of option -basic-blocks has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_BINARIES_PRESENT_DIFFER

const result cs::result::ERROR_BINARIES_PRESENT_DIFFER

static

The system cannot perform an incremental build because the presence of binary computation units has changed.

To resolve this, either reconfigure the build to include or exclude binary units as before, or rebuild the entire project.

◆ ERROR_CANNOT_FIND_PATH

const result cs::result::ERROR_CANNOT_FIND_PATH

static

Set when an associated path cannot be found, such as with sfileinst::include_tree_path().

◆ ERROR_CFG_EDGES_DIFFER

const result cs::result::ERROR_CFG_EDGES_DIFFER

static

The system cannot perform an incremental build because the setting of option -cfg-edges has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_CODESONAR_ONLY

const result cs::result::ERROR_CODESONAR_ONLY

static

The feature is only available in CodeSonar and not in CodeSurfer.

◆ ERROR_CODESURFER_ONLY

const result cs::result::ERROR_CODESURFER_ONLY

static

The feature is only available in CodeSurfer and not in CodeSonar.

◆ ERROR_COMPUNIT_HAS_NO_SFILEINST

const result cs::result::ERROR_COMPUNIT_HAS_NO_SFILEINST

static

Set when the user invokes a function with a ::csfe_compunit that doesn't have a sfileinst, for example, the function csfe_diagstream_compunit_parse_error needs a ::csfe_compunit with a sfileinst so the parse error can be associated with a file.

◆ ERROR_COMPUTE_SSA_DIFFER

const result cs::result::ERROR_COMPUTE_SSA_DIFFER

static

The system cannot perform an incremental build because the setting of option -compute-ssa has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_COUNT_UNKNOWN

const result cs::result::ERROR_COUNT_UNKNOWN

static

Set when the number of errors encountered in compiling an SDG is completely unknown.

◆ ERROR_COUNT_UNKNOWN_BUT_POSITIVE

const result cs::result::ERROR_COUNT_UNKNOWN_BUT_POSITIVE

static

Set when errors were encountered in compiling an SDG is not known, but the exact number is unknown.

◆ ERROR_CREATE_THREAD_FAILED

const result cs::result::ERROR_CREATE_THREAD_FAILED

static

Set when a thread cannot be created.

◆ ERROR_DISALLOWED_SET_KIND

const result cs::result::ERROR_DISALLOWED_SET_KIND

static

The set kind is valid but not allowed for a particular operation.

◆ ERROR_DISPLAY_USES_EXPRS_DIFFER

const result cs::result::ERROR_DISPLAY_USES_EXPRS_DIFFER

static

The system cannot perform an incremental build because the setting of option -display-uses-exprs has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_FATOBJ_STORE_DIRTY

const result cs::result::ERROR_FATOBJ_STORE_DIRTY

static

Set when the data store being opened is in an inconsistent state.

◆ ERROR_FATOBJ_STORE_OPEN_FAILED

const result cs::result::ERROR_FATOBJ_STORE_OPEN_FAILED

static

Set when cannot open a data store file.

◆ ERROR_FOREIGN_EXCEPTION

const result cs::result::ERROR_FOREIGN_EXCEPTION

static

An exception occured in a non-native language.

◆ ERROR_FORK_FAILED

const result cs::result::ERROR_FORK_FAILED

static

fork() did not succeed.

errno may contain additional information.

◆ ERROR_GET_COMPUTER_NAME_FAILED

const result cs::result::ERROR_GET_COMPUTER_NAME_FAILED

static

Set when the system function GetComputerName fails.

◆ ERROR_GET_HOST_NAME_FAILED

const result cs::result::ERROR_GET_HOST_NAME_FAILED

static

Set when the system function gethostname fails.

◆ ERROR_GET_PW_UID_FAILED

const result cs::result::ERROR_GET_PW_UID_FAILED

static

Set when the system function getpwuid fails.

This can be caused by intermittent NIS outages.

◆ ERROR_GET_USER_NAME_FAILED

const result cs::result::ERROR_GET_USER_NAME_FAILED

static

Set when the system function GetUserName fails.

This can be caused by intermittent domain controller outages.

◆ ERROR_GRAN_MISMATCH

const result cs::result::ERROR_GRAN_MISMATCH

static

Metric granularity does not match the operator.

◆ ERROR_HAMMOCK_NUM_EXIT_EDGE_SETS

const result cs::result::ERROR_HAMMOCK_NUM_EXIT_EDGE_SETS

static

Hammock w/ incorrect number of exit edge sets.

◆ ERROR_IMMUTABLE_DATA_STRUCTURE

const result cs::result::ERROR_IMMUTABLE_DATA_STRUCTURE

static

Set when an attempt is made to mutate an immutable data structure.

◆ ERROR_INCOMPATIBLE_VERSION

const result cs::result::ERROR_INCOMPATIBLE_VERSION

static

Error msg for incompatible version of Symantec Endpoint Protection, which causes kernel deadlock w/ hookcs driver.

◆ ERROR_INVALID_ABS_LOC_KIND

const result cs::result::ERROR_INVALID_ABS_LOC_KIND

static

Set when the user invokes a function with an invalid symbol_kind parameter.

◆ ERROR_INVALID_ARGUMENT

const result cs::result::ERROR_INVALID_ARGUMENT

static

An argument is not a valid instance of the required type.

◆ ERROR_INVALID_AST_CLASS

const result cs::result::ERROR_INVALID_AST_CLASS

static

Set when the user invokes a function with an invalid ast_class parameter.

◆ ERROR_INVALID_ATTRIBUTE

const result cs::result::ERROR_INVALID_ATTRIBUTE

static

The attribute is invalid.

◆ ERROR_INVALID_COLORING_ID

const result cs::result::ERROR_INVALID_COLORING_ID

static

Reserved for future use.

◆ ERROR_INVALID_FAMILY

const result cs::result::ERROR_INVALID_FAMILY

static

Set when the user invokes a function with an invalid ast_family parameter.

◆ ERROR_INVALID_FILTER_PDG_DIRECTIVE

const result cs::result::ERROR_INVALID_FILTER_PDG_DIRECTIVE

static

A depfilter_procedure_directive is not valid.

◆ ERROR_INVALID_FILTER_PDG_VERTEX_DIRECTIVE

const result cs::result::ERROR_INVALID_FILTER_PDG_VERTEX_DIRECTIVE

static

A depfilter_point_directive is not valid.

◆ ERROR_INVALID_FLAG

const result cs::result::ERROR_INVALID_FLAG

static

Set when the user invokes a function with an invalid flag parameter.

◆ ERROR_INVALID_KIND

const result cs::result::ERROR_INVALID_KIND

static

Set when the user invokes a function with an invalid kind parameter.

◆ ERROR_INVALID_LANGUAGE

const result cs::result::ERROR_INVALID_LANGUAGE

static

Set when the user invokes a function with an invalid language parameter.

◆ ERROR_INVALID_LINE

const result cs::result::ERROR_INVALID_LINE

static

Set when the user invokes a function with an invalid line_number parameter.

◆ ERROR_INVALID_LINE_POSITION

const result cs::result::ERROR_INVALID_LINE_POSITION

static

The position of the start of a line in a source file could not be determined.

◆ ERROR_INVALID_LINK_TYPE

const result cs::result::ERROR_INVALID_LINK_TYPE

static

Set when the user invokes a function with an invalid ::csfe_link_type parameter.

◆ ERROR_INVALID_OFFSET

const result cs::result::ERROR_INVALID_OFFSET

static

Set when a file offset is not within the bounds of the file.

◆ ERROR_INVALID_OPERATOR

const result cs::result::ERROR_INVALID_OPERATOR

static

The operator is invalid.

◆ ERROR_INVALID_PDG_EDGE_KIND

const result cs::result::ERROR_INVALID_PDG_EDGE_KIND

static

When user invokes a function with an invalid pdg_edge_kind.

◆ ERROR_INVALID_PDG_KIND

const result cs::result::ERROR_INVALID_PDG_KIND

static

When user invokes a function with an invalid procedure_kind, probably as part of a parameter.

◆ ERROR_INVALID_PHASE_FOR_OPERATION

const result cs::result::ERROR_INVALID_PHASE_FOR_OPERATION

static

The operation is not valid during this phase of the analysis.

Visitors are applied during different phases, as follows:

drop phase
setup
- csonar_add_setup_visitor() (C API only: for other languages, perform setup operations in the top level scope of your plug-in)
after program setup visitors, but before the beginning of the serial depth-first analysis phase
- analysis::add_project_visitor()
serial depth-first phase
- analysis::add_compunit_visitor()
- analysis::add_compunit_finish_visitor()
- analysis::add_sfile_visitor()
- analysis::add_sfile_finish_visitor()
- analysis::add_sfileinst_visitor()
- csonar_add_sfi_finish_visitor() (C API only)
- analysis::add_procedure_visitor()
- analysis::add_procedure_finish_visitor()
- analysis::add_point_visitor()
- analysis::add_symbol_visitor()
after serial depth-first phase but before any program parallel visitors
- analysis::add_project_finish_visitor()
after serial depth-first phase and program finish visitors but before the beginning of the parallel depth-first analysis phase
- csonar_add_program_parallel_visitor()
- csonar_add_uid_parallel_visitor()
- csonar_add_uid_parallel_finish_visitor()
- csonar_add_sf_parallel_visitor()
- csonar_add_sf_parallel_finish_visitor()
- csonar_add_sfi_parallel_visitor()
- csonar_add_sfi_parallel_finish_visitor()
- csonar_add_pdg_parallel_visitor()
- csonar_add_pdg_parallel_finish_visitor()
- csonar_add_pdg_parallel_vertex_visitor()
- csonar_add_abs_loc_parallel_visitor()
after parallel depth-first phase but before pointer analysis phase
- csonar_add_program_parallel_finish_visitor()
(pointer analysis phase occurs between parallel depth-first phase and bottom-up phase, but has no associated visitors)
after pointer analysis but before bottom-up phase
- analysis::add_project_bottom_up_visitor()
bottom-up phase
after bottom-up phase (all traversal finished)
- csonar_add_program_bottom_up_finish_visitor()

◆ ERROR_INVALID_PS_ENUM

const result cs::result::ERROR_INVALID_PS_ENUM

static

The predsucc_filter_directive is invalid.

◆ ERROR_INVALID_SDG

const result cs::result::ERROR_INVALID_SDG

static

Returned by project::load() if it is passed an invalid SDG file.

◆ ERROR_INVALID_SDG_STORE

const result cs::result::ERROR_INVALID_SDG_STORE

static

Returned by project::load() if it is passed an invalid store file.

◆ ERROR_INVALID_SEEK_RETURN_RANGE

const result cs::result::ERROR_INVALID_SEEK_RETURN_RANGE

static

The specified range spans across multiple physical source files, is out of the range, or start>end.

◆ ERROR_INVALID_SET_KIND

const result cs::result::ERROR_INVALID_SET_KIND

static

Set when the user invokes a function with an invalid set_kind parameter.

◆ ERROR_INVALID_SFID

const result cs::result::ERROR_INVALID_SFID

static

Set if an invalid sfileinst is given as a parameter, such as to sfileinst::name().

◆ ERROR_INVALID_SFID_OR_LINE

const result cs::result::ERROR_INVALID_SFID_OR_LINE

static

Set when either a relevant source file was deleted or changed or the given line number does not exist within the file.

◆ ERROR_INVALID_SFID_STRING

const result cs::result::ERROR_INVALID_SFID_STRING

static

Set if a std::string that is not a well-formed sfid is passed to cs_string_to_sfid() (C API only).

◆ ERROR_INVALID_SLAVE_OPERATION

const result cs::result::ERROR_INVALID_SLAVE_OPERATION

static

The operation is not valid from a slave process.

◆ ERROR_INVALID_SYNTAX_KIND

const result cs::result::ERROR_INVALID_SYNTAX_KIND

static

Set when an invalid syntax_kind is specified.

◆ ERROR_INVALID_TOKDEF_KIND

const result cs::result::ERROR_INVALID_TOKDEF_KIND

static

Reserved for future use.

◆ ERROR_INVALID_TYPE

const result cs::result::ERROR_INVALID_TYPE

static

Set when an invalid type is requested.

◆ ERROR_INVALID_UNITLINE

const result cs::result::ERROR_INVALID_UNITLINE

static

The compilation unit does not contain the specified line.

◆ ERROR_INVALID_VERTEX_KIND

const result cs::result::ERROR_INVALID_VERTEX_KIND

static

When user invokes a function with an invalid point_kind.

◆ ERROR_INVALID_VERTEX_SYNTAX_ELEMENT

const result cs::result::ERROR_INVALID_VERTEX_SYNTAX_ELEMENT

static

When user invokes a function with an invalid point_syntax_element.

◆ ERROR_INVALID_VERTEX_SYNTAX_KIND

const result cs::result::ERROR_INVALID_VERTEX_SYNTAX_KIND

static

When user invokes a function with an invalid point_syntax_kind.

◆ ERROR_IO_CLOSE

const result cs::result::ERROR_IO_CLOSE

static

Set when cannot close a file (close/CloseHandle).

◆ ERROR_IO_FLUSH

const result cs::result::ERROR_IO_FLUSH

static

Set when a flush operation (fsync/FlushFileBuffers) fails.

◆ ERROR_IO_GET_EOF

const result cs::result::ERROR_IO_GET_EOF

static

Set when a attempt to retrieve EOF fails (lseek/GetFileSizeEx).

◆ ERROR_IO_GET_POSITION

const result cs::result::ERROR_IO_GET_POSITION

static

Set when cannot get position of file pointer (lseek/SetFilePointerEx failed).

◆ ERROR_IO_LOCK

const result cs::result::ERROR_IO_LOCK

static

Set when a file is locked by another process.

◆ ERROR_IO_LOCKED_BY_OTHER

const result cs::result::ERROR_IO_LOCKED_BY_OTHER

static

Set when an attempt to remotely open a file for writing when the remote has the file open in read-only mode.

◆ ERROR_IO_MOVE_EOF

const result cs::result::ERROR_IO_MOVE_EOF

static

Set when cannot move EOF (ftruncate/SetEndOfFile).

◆ ERROR_IO_OPEN_FILE_LOCK_FAILURE

const result cs::result::ERROR_IO_OPEN_FILE_LOCK_FAILURE

static

Set when fcntl(f, F_SETLK, &lock) fails for a reason besides lock contention.

◆ ERROR_IO_OPEN_FILE_TO_READ

const result cs::result::ERROR_IO_OPEN_FILE_TO_READ

static

Set when cannot open a file to read.

◆ ERROR_IO_OPEN_FILE_TO_WRITE

const result cs::result::ERROR_IO_OPEN_FILE_TO_WRITE

static

Set when cannot open a file to write.

◆ ERROR_IO_READ

const result cs::result::ERROR_IO_READ

static

Set when a read operation (read/ReadFile) fails.

◆ ERROR_IO_READ_BAD_CHECKSUM

const result cs::result::ERROR_IO_READ_BAD_CHECKSUM

static

The checksum did not match.

◆ ERROR_IO_READ_PAST_EOF

const result cs::result::ERROR_IO_READ_PAST_EOF

static

Set when an attempt is made to read past EOF.

◆ ERROR_IO_READ_TOO_MUCH

const result cs::result::ERROR_IO_READ_TOO_MUCH

static

Set when a read operation (read/ReadFile) reads more bytes than were requested.

◆ ERROR_IO_READ_ZERO

const result cs::result::ERROR_IO_READ_ZERO

static

Set when a read operation (read/ReadFile) reads zero bytes.

◆ ERROR_IO_RENAME

const result cs::result::ERROR_IO_RENAME

static

Set when a file cannot be renamed.

◆ ERROR_IO_SEEK

const result cs::result::ERROR_IO_SEEK

static

Set when a seek operation (lseek/SetFilePointerEx) fails.

◆ ERROR_IO_SEEK_PAST_EOF

const result cs::result::ERROR_IO_SEEK_PAST_EOF

static

Set when an attempt is made to seek past EOF.

◆ ERROR_IO_SEEK_TO_EOF

const result cs::result::ERROR_IO_SEEK_TO_EOF

static

Set when cannot seek to EOF (lseek).

◆ ERROR_IO_STAT

const result cs::result::ERROR_IO_STAT

static

Set when cannot stat a file.

◆ ERROR_IO_WRITE

const result cs::result::ERROR_IO_WRITE

static

Set when a write operation (write/WriteFile) fails.

◆ ERROR_IO_WRITE_PAST_EOF

const result cs::result::ERROR_IO_WRITE_PAST_EOF

static

Set when an attempt is made to write past EOF.

◆ ERROR_IO_WRITE_TO_READ_ONLY

const result cs::result::ERROR_IO_WRITE_TO_READ_ONLY

static

Set when an attempt is made to write to a read only resource.

◆ ERROR_IO_WRITE_TOO_MUCH

const result cs::result::ERROR_IO_WRITE_TOO_MUCH

static

Set when a write operation (write/WriteFile) writes more bytes than were requested.

◆ ERROR_IO_WRITE_ZERO

const result cs::result::ERROR_IO_WRITE_ZERO

static

Set when a write operation (write/WriteFile) writes zero bytes.

◆ ERROR_LANGUAGE_NOT_FOUND

const result cs::result::ERROR_LANGUAGE_NOT_FOUND

static

Set in compunit::get_language() if the programming language cannot be determined.

◆ ERROR_LAUNCHD_NO_HOME

const result cs::result::ERROR_LAUNCHD_NO_HOME

static

A remote analysis was requested on a launchd that was never specified a home directory via -launchd-home.

◆ ERROR_LAUNCHD_QUOTA_EXCEEDED

const result cs::result::ERROR_LAUNCHD_QUOTA_EXCEEDED

static

A remote analysis was requested on a launchd that didn't have enough remaining quota space to handle the incoming .prj_files.

◆ ERROR_LICENSE_EXPIRED

const result cs::result::ERROR_LICENSE_EXPIRED

static

The license has expired since being checked out.

◆ ERROR_LICENSE_LOCK_LOST

const result cs::result::ERROR_LICENSE_LOCK_LOST

static

The lock on the license was lost, most likely because it was deleted or moved.

◆ ERROR_LICENSE_VERIFICATION_FAILED

const result cs::result::ERROR_LICENSE_VERIFICATION_FAILED

static

The license is corrupt; perhaps it was not transcribed correctly.

◆ ERROR_MISMATCH

const result cs::result::ERROR_MISMATCH

static

Set when a value or ID does not match expectations.

◆ ERROR_NEGATIVE_THRESHOLD

const result cs::result::ERROR_NEGATIVE_THRESHOLD

static

Set when a function is given a negative threshold.

◆ ERROR_NO_BACKWARD_CFG_EDGES

const result cs::result::ERROR_NO_BACKWARD_CFG_EDGES

static

Set when a function is called that depends on backward CFG edges but the current project was built without them.

◆ ERROR_NO_BASIC_BLOCKS

const result cs::result::ERROR_NO_BASIC_BLOCKS

static

Set when a function is called that depends on basic blocks but the current project was built without them.

◆ ERROR_NO_BUILDER_LICENSE

const result cs::result::ERROR_NO_BUILDER_LICENSE

static

No builder licenses are available.

◆ ERROR_NO_CFG_EDGES

const result cs::result::ERROR_NO_CFG_EDGES

static

Set when a function is called that depends on CFG edges but the current project was built without them.

◆ ERROR_NO_CONTAINER

const result cs::result::ERROR_NO_CONTAINER

static

Reserved for future use.

◆ ERROR_NO_CONTROL_DEPENDENCE

const result cs::result::ERROR_NO_CONTROL_DEPENDENCE

static

Set when a function is called that depends on control dependence but the current project was built with -control-dependence no.

◆ ERROR_NO_CONTROL_DEPENDENCE_LABELS

const result cs::result::ERROR_NO_CONTROL_DEPENDENCE_LABELS

static

Set when a function is called that depends on control dependence labels but the current project was built with -retain-control-dependence-labels no.

◆ ERROR_NO_DATA_DEPENDENCE

const result cs::result::ERROR_NO_DATA_DEPENDENCE

static

Set when a function is called that depends on data dependence but the current project was built with -data-dependence no.

◆ ERROR_NO_DECL_VERTICES

const result cs::result::ERROR_NO_DECL_VERTICES

static

When a function is called that depends on declaration vertices but the current project was built without it.

◆ ERROR_NO_DEPENDENCES

const result cs::result::ERROR_NO_DEPENDENCES

static

Set when a function is called that depends on dependence edges but the current project was built without them.

◆ ERROR_NO_EXCEPTIONS_OR_ABNORMAL_EXITS

const result cs::result::ERROR_NO_EXCEPTIONS_OR_ABNORMAL_EXITS

static

The project was not built with support for exceptions or abnormal exits, so the requested information is unavailable.

◆ ERROR_NO_GMOD

const result cs::result::ERROR_NO_GMOD

static

Set when a function is called that depends on gmod but the current project was built with -compute-gmod no.

◆ ERROR_NO_INTER_CFG_EDGES

const result cs::result::ERROR_NO_INTER_CFG_EDGES

static

Set when a function is called that depends on interprocedural CFG edges but the current project was built without them.

◆ ERROR_NO_LICENSE

const result cs::result::ERROR_NO_LICENSE

static

Set if a C API function is called without first checking out the license.

◆ ERROR_NO_POINTER_ANALYSIS

const result cs::result::ERROR_NO_POINTER_ANALYSIS

static

Set when a function is called that depends on pointer analysis but the current project was built without it.

◆ ERROR_NO_SCC

const result cs::result::ERROR_NO_SCC

static

Set when a function is called that depends on strongly connected components, but the current project was built without summary edges (which enable SCCs).

◆ ERROR_NO_SUB_OBJECT_ABS_LOCS

const result cs::result::ERROR_NO_SUB_OBJECT_ABS_LOCS

static

Set when a function is called that depends on subordinate abs locs (i.e., field abs locs) but the current project was built without them.

◆ ERROR_NO_SUCH_PDG_HAMMOCK

const result cs::result::ERROR_NO_SUCH_PDG_HAMMOCK

static

No such pdg hammock.

◆ ERROR_NO_SUMMARY_EDGES

const result cs::result::ERROR_NO_SUMMARY_EDGES

static

Set when a function is called that depends on summary edges, but the current project was built without them.

◆ ERROR_NO_USE_DEF_SETS

const result cs::result::ERROR_NO_USE_DEF_SETS

static

Set when a function is called that depends on CFG sets but the current project was built without them.

◆ ERROR_NONINCR_TO_INCR

const result cs::result::ERROR_NONINCR_TO_INCR

static

The system cannot perform an incremental build because the previous build was with INCREMENTAL_BUILD=No and so build-time temporary data was not retained for future builds.

◆ ERROR_NORM_DISJUNCTIVES_DIFFER

const result cs::result::ERROR_NORM_DISJUNCTIVES_DIFFER

static

The system cannot perform an incremental build because the setting of option -norm-disjunctives has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_NOT_A_CALL_SITE

const result cs::result::ERROR_NOT_A_CALL_SITE

static

The relevant vertex is not a call-site.

◆ ERROR_NOT_A_GLOBAL

const result cs::result::ERROR_NOT_A_GLOBAL

static

Set when the user invokes a function with a ::csfe_symbol that's not a global when the function only handles global symbol.

◆ ERROR_NOT_AN_ACTUAL_IN

const result cs::result::ERROR_NOT_AN_ACTUAL_IN

static

The relevant vertex is not an actual in.

◆ ERROR_NOT_AN_ACTUAL_OUT

const result cs::result::ERROR_NOT_AN_ACTUAL_OUT

static

The relevant vertex is not an actual out.

◆ ERROR_NOT_IN_BATCH_MODE

const result cs::result::ERROR_NOT_IN_BATCH_MODE

static

Internal use only.

◆ ERROR_NOT_INITIALIZED

const result cs::result::ERROR_NOT_INITIALIZED

static

Set when the user invokes a function in a module before the module is ready.

For example, csfe_diagstream_parse_error_no_location should not be called before frontend finishes its command line processing.

◆ ERROR_OUT_OF_MEMORY

const result cs::result::ERROR_OUT_OF_MEMORY

static

Set when an allocation fails.

◆ ERROR_OVERFLOW

const result cs::result::ERROR_OVERFLOW

static

Set when a value is too large or too small.

◆ ERROR_PARAM_EVAL_ORDER_DIFFER

const result cs::result::ERROR_PARAM_EVAL_ORDER_DIFFER

static

The system cannot perform an incremental build because the setting of configuration parameter PARAMETER_EVALUATION_ORDER has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_PARAMETER_TOO_LARGE

const result cs::result::ERROR_PARAMETER_TOO_LARGE

static

A parameter to the function exceeded the maximum allowable value.

◆ ERROR_PDG_VERTEX_TO_AST_MAPPING_DIFFER

const result cs::result::ERROR_PDG_VERTEX_TO_AST_MAPPING_DIFFER

static

The system cannot perform an incremental build because the setting of option -retain-pdg-vertex-to-ast-mapping has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_PI_NODES_DIFFER

const result cs::result::ERROR_PI_NODES_DIFFER

static

The system cannot perform an incremental build because the setting of option -pi-nodes has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_RANGE_CANNOT_BE_EMPTY

const result cs::result::ERROR_RANGE_CANNOT_BE_EMPTY

static

Set when the user invokes a function with an empty range when empty ones are not allowed.

◆ ERROR_RETAIN_UNNORMALIZED_C_AST_DIFFER

const result cs::result::ERROR_RETAIN_UNNORMALIZED_C_AST_DIFFER

static

The system cannot perform an incremental build because the setting of configuration parameter RETAIN_UNNORMALIZED_C_AST has changed.

To resolve this, either change the option setting back to its previous value or rebuild the entire project.

◆ ERROR_SDG_NOT_PRESENT

const result cs::result::ERROR_SDG_NOT_PRESENT

static

Set if the project is unbuilt (incomplete or non-existent SDG file) and a function is called that traverses the SDG.

◆ ERROR_UID_NOT_FOUND

const result cs::result::ERROR_UID_NOT_FOUND

static

No compilation unit exists for the specified compunit.

◆ ERROR_UNKNOWN_ABS_LOC_KIND

const result cs::result::ERROR_UNKNOWN_ABS_LOC_KIND

static

The kind of the symbol could not be determined.

◆ FILTERED_OUT

const result cs::result::FILTERED_OUT

static

An element was not submitted to the hub because it matched a configuration file discard rule.

Metric values are filtered with METRIC_FILTER rules; CodeSonar warnings are filtered with WARNING_FILTER rules.

◆ FRONT_END_DOES_NOT_IMPLEMENT_FEATURE

const result cs::result::FRONT_END_DOES_NOT_IMPLEMENT_FEATURE

static

The front end (parser) for this IR does not implement the requested feature.

◆ GENERATED_COMPILATION

const result cs::result::GENERATED_COMPILATION

static

The specified compunit corresponds to a compilation generated in the back end or by ir_factory::make_compunit().

◆ INCOMPATIBLE_ARGUMENTS

const result cs::result::INCOMPATIBLE_ARGUMENTS

static

The command-line arguments provided are incompatible.

◆ INTERNAL_ERROR_ABS_LOC_FUNCTION_TO_PDG_NO_PDG

const result cs::result::INTERNAL_ERROR_ABS_LOC_FUNCTION_TO_PDG_NO_PDG

static

Internal use only.

◆ INTERNAL_ERROR_ABS_LOC_SET_CLOSE

const result cs::result::INTERNAL_ERROR_ABS_LOC_SET_CLOSE

static

Internal use only.

◆ INTERNAL_ERROR_AIN_NO_CALL

const result cs::result::INTERNAL_ERROR_AIN_NO_CALL

static

Internal use only.

◆ INTERNAL_ERROR_BAD_ABS_LOC_KIND

const result cs::result::INTERNAL_ERROR_BAD_ABS_LOC_KIND

static

Internal use only.

◆ INTERNAL_ERROR_BAD_ABS_LOC_UID

const result cs::result::INTERNAL_ERROR_BAD_ABS_LOC_UID

static

Internal use only.

◆ INTERNAL_ERROR_BAD_FORMAL

const result cs::result::INTERNAL_ERROR_BAD_FORMAL

static

Internal use only.

◆ INTERNAL_ERROR_BB_SET_CLOSE

const result cs::result::INTERNAL_ERROR_BB_SET_CLOSE

static

Internal use only.

◆ INTERNAL_ERROR_CONNECTION_FAILED

const result cs::result::INTERNAL_ERROR_CONNECTION_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_CREATESERVICE_FAILED

const result cs::result::INTERNAL_ERROR_CREATESERVICE_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_DELETESERVICE_FAILED

const result cs::result::INTERNAL_ERROR_DELETESERVICE_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_DRVHOOKCS_ACTIVATE

const result cs::result::INTERNAL_ERROR_DRVHOOKCS_ACTIVATE

static

Internal use only.

◆ INTERNAL_ERROR_DRVHOOKCS_CONFIGURE

const result cs::result::INTERNAL_ERROR_DRVHOOKCS_CONFIGURE

static

Internal use only.

◆ INTERNAL_ERROR_DRVHOOKCS_FLTLIB_GETPROCADDRESS

const result cs::result::INTERNAL_ERROR_DRVHOOKCS_FLTLIB_GETPROCADDRESS

static

Internal use only.

◆ INTERNAL_ERROR_DRVHOOKCS_FLTLIB_LOADLIBRARY

const result cs::result::INTERNAL_ERROR_DRVHOOKCS_FLTLIB_LOADLIBRARY

static

Internal use only.

◆ INTERNAL_ERROR_DRVHOOKCS_INCOMPATIBLE_VERSION

const result cs::result::INTERNAL_ERROR_DRVHOOKCS_INCOMPATIBLE_VERSION

static

Internal use only.

◆ INTERNAL_ERROR_DRVHOOKCS_SINGLE_PARSE_VERSION

const result cs::result::INTERNAL_ERROR_DRVHOOKCS_SINGLE_PARSE_VERSION

static

Internal use only.

◆ INTERNAL_ERROR_GET_ISET

const result cs::result::INTERNAL_ERROR_GET_ISET

static

Internal use only.

◆ INTERNAL_ERROR_GET_LENGTH

const result cs::result::INTERNAL_ERROR_GET_LENGTH

static

Internal use only.

◆ INTERNAL_ERROR_GET_NTDLL_BASE_FAILED

const result cs::result::INTERNAL_ERROR_GET_NTDLL_BASE_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_GETCURRENTDIRECTORY_FAILED

const result cs::result::INTERNAL_ERROR_GETCURRENTDIRECTORY_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_GETCWD_FAILED

const result cs::result::INTERNAL_ERROR_GETCWD_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_IP_MAP_COMPUTE_FAIL

const result cs::result::INTERNAL_ERROR_IP_MAP_COMPUTE_FAIL

static

Internal use only.

◆ INTERNAL_ERROR_IP_SET_CLOSE

const result cs::result::INTERNAL_ERROR_IP_SET_CLOSE

static

Internal use only.

◆ INTERNAL_ERROR_KERNEL_OBJECT_NAME_UNKNOWN

const result cs::result::INTERNAL_ERROR_KERNEL_OBJECT_NAME_UNKNOWN

static

Internal use only.

◆ INTERNAL_ERROR_MULTIBYTETOWIDECHAR

const result cs::result::INTERNAL_ERROR_MULTIBYTETOWIDECHAR

static

Internal use only.

◆ INTERNAL_ERROR_NO_VALUESET_INTERFACE

const result cs::result::INTERNAL_ERROR_NO_VALUESET_INTERFACE

static

Internal use only.

◆ INTERNAL_ERROR_NULL_ABS_LOC_FIELD

const result cs::result::INTERNAL_ERROR_NULL_ABS_LOC_FIELD

static

Internal use only.

◆ INTERNAL_ERROR_NULL_ABS_LOC_FIELDS

const result cs::result::INTERNAL_ERROR_NULL_ABS_LOC_FIELDS

static

Internal use only.

◆ INTERNAL_ERROR_NULL_INL_TARGET

const result cs::result::INTERNAL_ERROR_NULL_INL_TARGET

static

Internal use only.

◆ INTERNAL_ERROR_NULL_INL_TARGETS

const result cs::result::INTERNAL_ERROR_NULL_INL_TARGETS

static

Internal use only.

◆ INTERNAL_ERROR_NULL_LAST_VERTEX

const result cs::result::INTERNAL_ERROR_NULL_LAST_VERTEX

static

Internal use only.

◆ INTERNAL_ERROR_NULL_LAST_VERTEX_2

const result cs::result::INTERNAL_ERROR_NULL_LAST_VERTEX_2

static

Internal use only.

◆ INTERNAL_ERROR_OPENSCMANAGER_FAILED

const result cs::result::INTERNAL_ERROR_OPENSCMANAGER_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_OPENSERVICE_FAILED

const result cs::result::INTERNAL_ERROR_OPENSERVICE_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_PDG_CALL_NO_CALLEE

const result cs::result::INTERNAL_ERROR_PDG_CALL_NO_CALLEE

static

Internal use only.

◆ INTERNAL_ERROR_PDG_CALL_NO_CALLEE_2

const result cs::result::INTERNAL_ERROR_PDG_CALL_NO_CALLEE_2

static

Internal use only.

◆ INTERNAL_ERROR_PDG_CALL_NO_CALLEE_3

const result cs::result::INTERNAL_ERROR_PDG_CALL_NO_CALLEE_3

static

Internal use only.

◆ INTERNAL_ERROR_PDG_MISSING

const result cs::result::INTERNAL_ERROR_PDG_MISSING

static

Internal use only.

◆ INTERNAL_ERROR_PDG_MISSING_02

const result cs::result::INTERNAL_ERROR_PDG_MISSING_02

static

Internal use only.

◆ INTERNAL_ERROR_PDGV_SET_CLOSE

const result cs::result::INTERNAL_ERROR_PDGV_SET_CLOSE

static

Internal use only.

◆ INTERNAL_ERROR_QUERYSERVICESTATUS_FAILED

const result cs::result::INTERNAL_ERROR_QUERYSERVICESTATUS_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_REGISTRY_WRITE_FAILED

const result cs::result::INTERNAL_ERROR_REGISTRY_WRITE_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_SERVICE_DID_NOT_START

const result cs::result::INTERNAL_ERROR_SERVICE_DID_NOT_START

static

Internal use only.

◆ INTERNAL_ERROR_SERVICE_UNEXPECTED_STATE

const result cs::result::INTERNAL_ERROR_SERVICE_UNEXPECTED_STATE

static

Internal use only.

◆ INTERNAL_ERROR_STARTSERVICE_FAILED

const result cs::result::INTERNAL_ERROR_STARTSERVICE_FAILED

static

Internal use only.

◆ INTERNAL_ERROR_TERMINAL_SERVER_NOT_OK

const result cs::result::INTERNAL_ERROR_TERMINAL_SERVER_NOT_OK

static

Internal use only.

◆ INTERNAL_ERROR_TRY_AGAIN_LATER

const result cs::result::INTERNAL_ERROR_TRY_AGAIN_LATER

static

Internal use only.

◆ INTERNAL_ERROR_U2S_MISSING_TMPDIR

const result cs::result::INTERNAL_ERROR_U2S_MISSING_TMPDIR

static

Internal use only.

◆ INTERNAL_ERROR_UID_SFID_HANDLES_MISSING_TMPDIR

const result cs::result::INTERNAL_ERROR_UID_SFID_HANDLES_MISSING_TMPDIR

static

Internal use only.

◆ INTERNAL_ERROR_UID_SFID_HANDLES_NOT_DEFINED

const result cs::result::INTERNAL_ERROR_UID_SFID_HANDLES_NOT_DEFINED

static

Internal use only.

◆ INTERNAL_ERROR_UID_SFID_HANDLES_NOT_LIST

const result cs::result::INTERNAL_ERROR_UID_SFID_HANDLES_NOT_LIST

static

Internal use only.

◆ INTERNAL_ERROR_UID_SFID_HANDLES_NOT_PAIR

const result cs::result::INTERNAL_ERROR_UID_SFID_HANDLES_NOT_PAIR

static

Internal use only.

◆ INTERNAL_ERROR_UID_SFID_HANDLES_NOT_SFID

const result cs::result::INTERNAL_ERROR_UID_SFID_HANDLES_NOT_SFID

static

Internal use only.

◆ INTERNAL_ERROR_UID_SFID_HANDLES_NOT_SHANDLE

const result cs::result::INTERNAL_ERROR_UID_SFID_HANDLES_NOT_SHANDLE

static

Internal use only.

◆ INTERNAL_ERROR_UNEXPECTED_MESSAGE

const result cs::result::INTERNAL_ERROR_UNEXPECTED_MESSAGE

static

Internal use only.

◆ INTERNAL_ERROR_UNEXPECTED_RESPONSE_CODE

const result cs::result::INTERNAL_ERROR_UNEXPECTED_RESPONSE_CODE

static

Internal use only.

◆ INTERNAL_ERROR_UNFAMILIAR_SYSCALL

const result cs::result::INTERNAL_ERROR_UNFAMILIAR_SYSCALL

static

Internal use only.

◆ INTERNAL_ERROR_UNION_P_FAILS

const result cs::result::INTERNAL_ERROR_UNION_P_FAILS

static

Internal use only.

◆ INTERNAL_ERROR_UNKNOWN

const result cs::result::INTERNAL_ERROR_UNKNOWN

static

This error should never be seen by an API client, even when something is horribly wrong.

◆ INTERNAL_ERROR_VALUESET_NOT_FOUND

const result cs::result::INTERNAL_ERROR_VALUESET_NOT_FOUND

static

Internal use only.

◆ INTERNAL_STOP_TRAVERSAL

const result cs::result::INTERNAL_STOP_TRAVERSAL

static

Stop traversal.

◆ INVALID_DATA_FORMAT

const result cs::result::INVALID_DATA_FORMAT

static

The data was not in a valid format for the operation.

◆ METRIC_NOT_COMPUTED

const result cs::result::METRIC_NOT_COMPUTED

static

The requested metric value was not computed.

◆ MODULE_IR_NOT_AVAILABLE

const result cs::result::MODULE_IR_NOT_AVAILABLE

static

The requested information is not available for the given module, because the module is summarized.

◆ NO_BOUNDS

const result cs::result::NO_BOUNDS

static

The requested element has no upper or lower bound.

◆ NO_LOWER_BOUND

const result cs::result::NO_LOWER_BOUND

static

The requested element has no lower bound.

◆ NO_POSITION

const result cs::result::NO_POSITION

static

The compilation does not have any position information, for example because it is generated by the back end.

◆ NO_PRIMARY_DECLARATION

const result cs::result::NO_PRIMARY_DECLARATION

static

No primary declaration found for a symbol.

◆ NO_REPRESENTED_STRING

const result cs::result::NO_REPRESENTED_STRING

static

Returned by symbol::represented_string() when the string associated with the specified symbol cannot be found.

◆ NO_SOURCE_CORRESPONDENCE

const result cs::result::NO_SOURCE_CORRESPONDENCE

static

An IR element does not correspond to any source code so a request for coordinates in source code (e.g., a line number) has failed.

For example, an attempt to determine the line number of a compiler-synthesized procedure would cause this.

◆ NO_SUCH_BASIC_BLOCK

const result cs::result::NO_SUCH_BASIC_BLOCK

static

Returned by procedure::retrieve_basic_block() when there is no such basic block.

◆ NO_SUCH_PDG

const result cs::result::NO_SUCH_PDG

static

Returned by project::find_procedure() when there is no such pdg.

◆ NO_SUCH_PDG_VERTEX

const result cs::result::NO_SUCH_PDG_VERTEX

static

Returned by procedure::retrieve_point() when there is no such vertex.

◆ NO_UPPER_BOUND

const result cs::result::NO_UPPER_BOUND

static

The requested element has no upper bound.

◆ NOT_A_MANGLED_NAME

const result cs::result::NOT_A_MANGLED_NAME

static

An attempt was made to demangle a name that is not a mangled name.

◆ NOT_IMPLEMENTED

const result cs::result::NOT_IMPLEMENTED

static

The functionality is not implemented for the provided inputs.

◆ NOT_MACHINE_CODE

const result cs::result::NOT_MACHINE_CODE

static

The given UID is not a machine-code module.

◆ ON_BAD_FILE_SYSTEM

const result cs::result::ON_BAD_FILE_SYSTEM

static

The file is on a file system that could cause reliability or performance problems.

◆ OUT_OF_ELEMENTS

const result cs::result::OUT_OF_ELEMENTS

static

An iterator ran out of elements.

◆ PATH_INFEASIBLE

const result cs::result::PATH_INFEASIBLE

static

The path in question is infeasible.

◆ PDG_HAS_NO_NORMAL_EXIT

const result cs::result::PDG_HAS_NO_NORMAL_EXIT

static

The procedure has no normal exit vertex.

Normal-exit vertices are not generated in procedures that do not throw exceptions or have abnormal exits.

◆ PDG_HAS_NO_NORMAL_RETURN

const result cs::result::PDG_HAS_NO_NORMAL_RETURN

static

The procedure has no normal return vertex.

Normal-return vertices are not generated for call-sites that do not throw exceptions or have abnormal exits.

◆ PDG_IS_UNDEFINED

const result cs::result::PDG_IS_UNDEFINED

static

The procedure represents an undefined function.

◆ PDG_NOT_FOUND

const result cs::result::PDG_NOT_FOUND

static

A procedure with the given name cannot be found.

◆ PDG_VERTEX_HAS_NO_SYMBOL

const result cs::result::PDG_VERTEX_HAS_NO_SYMBOL

static

The point has no symbol.

◆ PDG_VERTEX_HAS_ZERO_OR_MULTIPLE_PREDECESSORS

const result cs::result::PDG_VERTEX_HAS_ZERO_OR_MULTIPLE_PREDECESSORS

static

The point does not have exactly one predecessor.

◆ PDG_VERTEX_HAS_ZERO_OR_MULTIPLE_SUCCESSORS

const result cs::result::PDG_VERTEX_HAS_ZERO_OR_MULTIPLE_SUCCESSORS

static

The point does not have exactly one successor.

◆ PDGV_NOT_IN_BASIC_BLOCK

const result cs::result::PDGV_NOT_IN_BASIC_BLOCK

static

A basic block related function (such as point::get_basic_block() ) is invoked on a point that is not part of a basic block.

◆ REPLACED

const result cs::result::REPLACED

static

The key already exists in the data structure, the old element was replaced with the new one.

◆ SSL_CERTIFICATE_ERROR

const result cs::result::SSL_CERTIFICATE_ERROR

static

One of several issues with the server's TLS/SSL certificate make it invalid.

◆ SSL_CERTIFICATE_HOSTNAME_MISMATCH

const result cs::result::SSL_CERTIFICATE_HOSTNAME_MISMATCH

static

The server's TLS/SSL certificate indicates via the Common Name field that it is intended for a different hostname than appears in the URL being used.

◆ SUCCESS

const result cs::result::SUCCESS

static

The function was successful.

◆ TIMEOUT

const result cs::result::TIMEOUT

static

A time out occurred.

◆ TRUNCATED

const result cs::result::TRUNCATED

static

A user-allocated buffer was too small so the result was truncated.

◆ VERTEX_HAS_NO_RANK

const result cs::result::VERTEX_HAS_NO_RANK

static

The point is not a {formal,actual}-{in,out} or a global-{formal,actual}-{in,out} and, therefore, has no rank.

The documentation for this class was generated from the following file:

cs_result.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Related Functions

Detailed Description

Member Function Documentation

◆ as_integer()

◆ as_repr()

◆ as_string()

◆ check()

◆ cmp()

◆ from_integer()

◆ hash()

◆ name()

Friends And Related Function Documentation

◆ operator!=()

◆ operator<()

◆ operator<<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

Member Data Documentation

◆ ABS_LOC_HAS_NO_INLINE_SOURCE

◆ ABS_LOC_HAS_NO_PARENT

◆ ABS_LOC_HAS_NO_PDG

◆ ABS_LOC_IS_GLOBAL

◆ ABS_LOC_NOT_FUNCTION

◆ ABS_LOC_PDG_UNDEFINED

◆ ACCESS_DENIED

◆ AMC_IS_BOTTOM

◆ AMC_NOT_AVAILABLE

◆ CALLER_SHOULD_HANDLE

◆ DECLARATIONS_UNKNOWN

◆ DEMANGLE_FAILED

◆ DISABLED

◆ DISCRETIONARY_ERROR_IO_PARTIAL_READ

◆ ELEMENT_ALREADY_PRESENT

◆ ELEMENT_NOT_PRESENT

◆ ERROR_AN_SDG_ALREADY_PRESENT

◆ ERROR_ANALYSIS_NOT_RUN

◆ ERROR_ARGUMENT_CANNOT_BE_EMPTY

◆ ERROR_ARGUMENT_CANNOT_BE_NULL

◆ ERROR_BASIC_BLOCKS_DIFFER

◆ ERROR_BINARIES_PRESENT_DIFFER

◆ ERROR_CANNOT_FIND_PATH

◆ ERROR_CFG_EDGES_DIFFER

◆ ERROR_CODESONAR_ONLY

◆ ERROR_CODESURFER_ONLY

◆ ERROR_COMPUNIT_HAS_NO_SFILEINST

◆ ERROR_COMPUTE_SSA_DIFFER

◆ ERROR_COUNT_UNKNOWN

◆ ERROR_COUNT_UNKNOWN_BUT_POSITIVE

◆ ERROR_CREATE_THREAD_FAILED

◆ ERROR_DISALLOWED_SET_KIND

◆ ERROR_DISPLAY_USES_EXPRS_DIFFER

◆ ERROR_FATOBJ_STORE_DIRTY

◆ ERROR_FATOBJ_STORE_OPEN_FAILED

◆ ERROR_FOREIGN_EXCEPTION

◆ ERROR_FORK_FAILED

◆ ERROR_GET_COMPUTER_NAME_FAILED

◆ ERROR_GET_HOST_NAME_FAILED

◆ ERROR_GET_PW_UID_FAILED

◆ ERROR_GET_USER_NAME_FAILED

◆ ERROR_GRAN_MISMATCH

◆ ERROR_HAMMOCK_NUM_EXIT_EDGE_SETS

◆ ERROR_IMMUTABLE_DATA_STRUCTURE

◆ ERROR_INCOMPATIBLE_VERSION

◆ ERROR_INVALID_ABS_LOC_KIND

◆ ERROR_INVALID_ARGUMENT

◆ ERROR_INVALID_AST_CLASS

◆ ERROR_INVALID_ATTRIBUTE

◆ ERROR_INVALID_COLORING_ID

◆ ERROR_INVALID_FAMILY

◆ ERROR_INVALID_FILTER_PDG_DIRECTIVE

◆ ERROR_INVALID_FILTER_PDG_VERTEX_DIRECTIVE

◆ ERROR_INVALID_FLAG

◆ ERROR_INVALID_KIND

◆ ERROR_INVALID_LANGUAGE

◆ ERROR_INVALID_LINE