• CS_ERROR_INVALID_VERTEX_KIND if kind is not valid,
• CS_SUCCESS otherwise.

• Identifiers are unique within each cs_pdg.
• In an incremental analysis where the containing compilation unit is not recompiled, a cs_pdg_vertex will have the same identifier that it did in the incremental parent.
• In all other cases identifiers do not persist between different analyses of the same project (or the same code in a different project).

To get a cs_pdg_vertex given its ID, use cs_pdg_retrieve_vertex().

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded,
• CS_SUCCESS otherwise.

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded.
• CS_ELEMENT_NOT_PRESENT pv has no associated AST of family ast_family. This includes the case where the project was not built to include ASTs of family ast_family, and the case where ast_family is csaf_c_unnormalized.
• CS_SUCCESS otherwise.

• CS_SUCCESS on success.
• CS_NO_POSITION if pv does not have a position in any file in the project

• CS_NO_POSITION if pv does not have a position in any file in the project;
• CS_SUCCESS otherwise

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded.
• CS_ELEMENT_NOT_PRESENT if pv does not occur in the project, or if position information for pv is not available.
• CS_TRUNCATED if out_string is not large enough to hold the entire string representation of pv (and so the string was truncated).
• CS_SUCCESS otherwise.

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

• CS_VERTEX_HAS_NO_RANK if pv is not a {formal,actual}-{in,out} or a global-{formal,actual}-{in,out} vertex,
• CS_SUCCESS otherwise.

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded.
• CS_ERROR_NO_DEPENDENCES [CodeSonar only] if the kind of pv is one of cs_vertex_kind_exit, cs_vertex_kind_call_site, cs_vertex_kind_indirect_call, cs_vertex_kind_actual_in. This affects only CodeSonar: CodeSurfer retains more dependence information.
• CS_SUCCESS otherwise.

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded.
• CS_SUCCESS otherwise.

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded.
• CS_PDG_VERTEX_HAS_ZERO_OR_MULTIPLE_SUCCESSORS if pv does not have exactly one successor CFG edge.
• CS_SUCCESS otherwise.

See CFG Edges for more information.

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded.
• CS_ERROR_NOT_AN_ACTUAL_IN if pv does not represent an actual-in.
• CS_ELEMENT_NOT_PRESENT if there is no call site associated with pv.
• CS_ERROR_NOT_A_CALL_SITE if the call site associated with pv is an indirect call.
• CS_PDG_IS_UNDEFINED if the call site associated with pv is a call to an undefined function.
• CS_SUCCESS otherwise.

The modeling of the GNU extension __builtin_apply leads to the possibility that more than one formal can be associated with a given actual. In this case, the cs_pdg_vertex_set returned will contain several formals.

• CS_ERROR_NOT_A_CALL_SITE if pv does not represent a call site,
• CS_SUCCESS otherwise.

• CS_ERROR_NOT_A_CALL_SITE if pv does not represent a call site,
• CS_SUCCESS otherwise.

• CS_ERROR_NOT_A_CALL_SITE if pv does not represent a call site,
• CS_TRUNCATED if actual_ins is not large enough to hold the entire list of actual-in points (cs_pdg_vertex) and so the list was truncated,
• CS_SUCCESS otherwise.

• CS_ERROR_NOT_A_CALL_SITE if pv does not represent a call site,
• CS_TRUNCATED if actual_outs is not large enough to hold then full list of actual-out vertices (and so the list was truncated),
• CS_SUCCESS otherwise.

• CS_ERROR_NOT_A_CALL_SITE if pv does not represent a call site,
• CS_ERROR_INVALID_ARGUMENT if rank is 0,
• CS_ELEMENT_NOT_PRESENT if no actual-in exists with the specified rank,
• CS_SUCCESS otherwise.

• CS_ERROR_NOT_A_CALL_SITE if pv does not represent a call site,
• CS_ERROR_INVALID_ARGUMENT if rank is 0,
• CS_ELEMENT_NOT_PRESENT if no actual-out exists with the specified rank,
• CS_SUCCESS otherwise.

In most languages (including C and C++), only an actual-out of rank 1 can exist. It corresponds to the return value of a function.

• CS_SUCCESS if the call site was written to out,
• CS_ELEMENT_NOT_PRESENT if no such call-site exists.

• CS_ERROR_SDG_NOT_PRESENT if no project is loaded,
• CS_ERROR_NOT_A_CALL_SITE if call_site does not represent a call site,
• CS_ELEMENT_NOT_PRESENT if there is no callee associated with call_site ,
• CS_SUCCESS otherwise.

• cs_true if v lies entirely inside a C or C++ macro expansion.
• cs_false otherwise, including the case where only part of v is inside a macro expansion.

• cs_true if v is an actual-in and if that actual-in is implicit.
• cs_false otherwise

• CS_ERROR_INVALID_ARGUMENT if the cs_vertex_kind of pv is not one of cs_vertex_kind_actual_in, cs_vertex_kind_expression, cs_vertex_kind_call_site, or cs_vertex_kind_control_point.
• CS_ELEMENT_NOT_PRESENT if this particular vertex does not have this information.
• CS_SUCCESS otherwise.

Do not modify or free the returned buffer.

This function entails less user overhead than cs_pdg_vertex_source_pp(), 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.

If you do not need hash values to be stable across analyses, use cs_pdg_vertex_hash(): it has better performance.

• N<0 if pv_a considered less than pv_b
• N==0 if pv_a and pv_b are the same cs_pdg_vertex
• N>0 if pv_a considered greater than pv_b

The comparison is stable in the following sense. Suppose there are two analyses A1 and A2 generated with exactly the same inputs (including identical analyzed code, underlying build commands and ordering, command line and configuration settings, increment order and contents). Let a1 and b1 be two cs_pdg_vertex values in A1, and a2 and b2 be the cs_pdg_vertex values in A2 that correspond to a1 and b1 respectively. Then cs_pdg_vertex_stable_compare(a1,b1)==cs_pdg_vertex_stable_compare(a2,b2).

If you do not need comparison results to be stable across different analyses, use cs_pdg_vertex_compare(): it has better performance.

• CS_SUCCESS on success,
• CS_TRUNCATED if the provided buffer is not large enough to hold the handle.

• CS_SUCCESS on success,
• CS_ERROR_INVALID_ARGUMENT if pdg_vertex_handle is not valid,
• CS_ERROR_IO_READ_PAST_EOF if the handle parameter is too short to be a valid handle.
• CS_ERROR_SDG_NOT_PRESENT if there is no current System Dependence Graph.
• CS_ELEMENT_NOT_PRESENT if there is no pdg_vertex matching pdg_vertex_handle.

• N<0 if pv_a is considered less than pv_b
• N==0 if pv_a and pv_b are the same cs_pdg_vertex
• N>0 if pv_a is considered greater than pv_b

For fixed cs_pdg_vertex values a and b in a single analysis, cs_pdg_vertex_compare(a,b) will always return the same value. However, cs_pdg_vertex_compare() will not necessarily return this same value when called on the corresponding cs_pdg_vertex values a' and b' in a different analysis. Function cs_pdg_vertex_stable_compare() provides some degree of stability across analyses, although restrictions still apply. If you do not need comparison results to be stable across different analyses, use cs_pdg_vertex_compare(): it has better performance.