• cs_true if lang is a machine-code language,
• cs_false otherwise (including csl_wildcard and csl_synthetic).

• CS_ERROR_UID_NOT_FOUND if there is no cs_file_path associated with uid,
• CS_TRUNCATED if file_path is not large enough to hold the entire file path (and so the file path was truncated),
• CS_SUCCESS otherwise.

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

• CS_ERROR_UID_NOT_FOUND if there is no cs_file_path associated with uid,
• CS_TRUNCATED if file_path is not large enough to hold the entire file path (and so the file path was truncated),
• CS_SUCCESS otherwise.

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

• CS_ERROR_CANNOT_FIND_PATH if there is no include path associated with sfid,
• CS_TRUNCATED if rpath is not large enough to hold the entire include path (and so the include path was truncated),
• CS_SUCCESS otherwise.

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

• CS_ERROR_CANNOT_FIND_PATH if there is no absolute path name associated with sfid,
• CS_TRUNCATED if pname is not large enough to hold the entire absolute path name (and so the path name was truncated),
• CS_SUCCESS otherwise.

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

• CS_ERROR_CANNOT_FIND_PATH if there is no absolute path name associated with sfid,
• CS_TRUNCATED if pname is not large enough to hold the entire absolute path name (and so the path name was truncated),
• CS_SUCCESS otherwise.

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

• CS_ERROR_CANNOT_FIND_PATH if there is no absolute path name associated with sfid,
• CS_SUCCESS otherwise.

• CS_ERROR_CANNOT_FIND_PATH if there is no absolute path name associated with sfid,
• CS_SUCCESS otherwise.

• CS_ERROR_IO_OPEN_FILE_TO_READ if the file identified by sfid cannot be opened for reading,
• CS_ERROR_IO_SEEK if ( line_start, col_start ) is not a valid position within sfid,
• CS_ERROR_IO_READ if line_end is not a valid line within sfid,
• CS_DISCRETIONARY_ERROR_IO_PARTIAL_READ if col_end is not a valid column within line_end,
• CS_TRUNCATED if substr was not large enough to hold the entire substring (and so the substring was truncated),
• CS_ERROR_INVALID_ARGUMENT if the specified start location is after the specified end location.
• CS_SUCCESS otherwise.

• CS_ERROR_UID_NOT_FOUND if the compilation unit identified by uid does not exist.
• CS_ERROR_INVALID_ARGUMENT if ast_family is not a valid cs_ast_family.
• CS_ELEMENT_NOT_PRESENT if no such AST is associated with the compilation unit.
• CS_SUCCESS otherwise.

• CS_SUCCESS if the entire requested list of cs_ast was copied into out_asts.
• CS_TRUNCATED if out_asts is not large enough to hold the entire list of cs_ast (and so the list was truncated).
• CS_NOT_IMPLEMENTED if the retrieval function is not implemented for the language module being used. (Retrieval is implemented for the C/C++ language module.)
• CS_ELEMENT_NOT_PRESENT if uid is not present in the project, or if the information is not available for the compilation.

• CS_ERROR_INVALID_SFID_OR_LINE if sfid is not valid or fline is outside the boundaries of sfid,
• CS_SUCCESS otherwise.

• CS_ERROR_INVALID_SFID_OR_LINE if sfid is not valid or fline is outside the boundaries of source file instance indicated by sfid,
• CS_SUCCESS otherwise.

• CS_ELEMENT_NOT_PRESENT if point_offset is not within the bounds of the source file instance identified by sfid,
• CS_SUCCESS otherwise.

• CS_ELEMENT_NOT_PRESENT if point_offset is not within the bounds of the source file instance identified by sfid,
• CS_SUCCESS otherwise.

• CS_ERROR_UID_NOT_FOUND if the compilation unit indicated by uid does not exist,
• CS_SUCCESS otherwise.

• CS_ERROR_UID_NOT_FOUND if the compilation unit indicated by uid does not exist,
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_SUCCESS otherwise.

For Java compilation units, group_uid is the first cs_uid encountered during the cs-java-scan invocation that produced the compilation unit with uid. This may be an existing compilation unit UID for a .java file that is being reanalyzed, or a new UID produced for a .java file that does not already have a corresponding compilation unit in the project.

For C# compilation units, the situation is analogous to that for Java: group_uid is the first cs_uid encountered during the cs-dotnet-scan invocation that produced the compilation unit with uid.

For example, suppose cs-java-scan is invoked on a file J.jar containing two class files: A.class and B.class. Then:

• Two compilation units will be produced from this invocation: one for A.class and one for B.class. We will refer to the compilation unit UIDs for these as UID_A and UID_B, respectively.
• These two compilation units constitute a group, because they were produced by the same cs-java-scan invocation.
• The group UID of the group is either UID_A or UID_B, depending on whether A.class and B.class was encountered first during the cs-java-scan invocation.

Additional notes:

• Group UIDs and invocations of cs-java-scan / cs-dotnet-scan / C/C++ compiler are NOT in one-to-one correspondence in general.
• Do not use group_uid in contexts that require a cs_uid. Depending on the sequence of events during the CodeSonar project build phase, it may no longer refer to a compilation unit that is present in the project.
• For Java and C#, the group UID for a compilation unit can change as the project is built. In particular, if the same artifact is built into the CodeSonar project multiple times via multiple invocations of cs-java-scan or cs-dotnet-scan, the first compilation unit encountered is not necessarily the same each time.

  For example, say A.class is encountered first in an earlier invocation of cs-bin-scan on J.jar. Then the group UID for the compilation units corresponding to A.class and B.class will be UID_A. If A.class is then removed from J.jar and cs-bin-scan is invoked again, B.class will be encountered first (because it is the only class left) and so the group UID for the compilation unit corresponding to B.class is updated to UID_B.

• For C and C++, the group UID of an existing compilation unit does not change, and will always match the compilation unit UID.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if Web ID information for the compilation unit is not available.
• CS_TRUNCATED if webid is not large enough to hold the entire Web ID (and so it was truncated).

Call this function with webid NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire web ID.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if compiler model information for the compilation unit is not available.
• CS_TRUNCATED if compiler_model is not large enough to hold the entire compiler model string (and so it was truncated).

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if native command line information for the compilation unit is not available.
• CS_TRUNCATED if outbuf is not large enough to hold the entire command line (and so it was truncated).

Call this function with outbuf NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire command line.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if build flag information for the compilation is not available.
• CS_TRUNCATED if outbuf is not large enough to hold all the effective flags (and so it was truncated).

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

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if the information is not available for the compilation.
• CS_TRUNCATED if outbuf is not large enough to hold the entire command line (and so it was truncated).

Call this function with outbuf NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire command line.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if the information is not available for the compilation.
• CS_TRUNCATED if outbuf is not large enough to hold the entire command line (and so it was truncated).

Call this function with outbuf NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire command line.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if the information is not available for the compilation.
• CS_TRUNCATED if outbuf is not large enough to hold the entire command line (and so it was truncated).

Call this function with outbuf NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire command line.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if the information is not available for the compilation.
• CS_TRUNCATED if outbuf is not large enough to hold the entire command line (and so it was truncated).

Call this function with outbuf NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire command line.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.
• CS_GENERATED_COMPILATION if uid represents a compilation unit that was created with cs_uid_create() or generated in the back end.
• CS_ELEMENT_NOT_PRESENT if the information is not available for the compilation.
• CS_TRUNCATED if outbuf is not large enough to hold the entire command line (and so it was truncated).

Call this function with outbuf NULL and capacity_bytes 0 (zero) to determine the memory needed to hold the entire command line.

• CS_ERROR_COUNT_UNKNOWN if the error count is unknown or if the warning counting mechanism is unsupported in this project,
• CS_ERROR_COUNT_UNKNOWN_BUT_POSITIVE if errors occured but the number could not be determined,
• CS_SUCCESS otherwise.

• CS_ERROR_COUNT_UNKNOWN if the warning count is unknown or if the warning counting mechanism is unsupported in this project,
• CS_ERROR_COUNT_UNKNOWN_BUT_POSITIVE if warnings occured but the number could not be determined,
• CS_SUCCESS otherwise.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if the compilation unit identified by uid does not exist.
• CS_GENERATED_COMPILATION if uid represents a compilation that was created with cs_uid_create() or generated in the back end.

• cs_true if the sfid is considered a system include.
• cs_false otherwise.

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

• CS_SUCCESS on success.
• CS_OUT_OF_ELEMENTS if the specified file instance has no #included children.

• CS_SUCCESS on success.
• CS_OUT_OF_ELEMENTS if the iterator traversal has finished and there are no children left to retrieve.

• CS_ELEMENT_NOT_PRESENT if the source file is not included.
• CS_SUCCESS otherwise.

• CS_ELEMENT_NOT_PRESENT if no file is included at the given location. For example, this will occur if sfid is a C source file and include_line does not contain a #include directive.
• CS_SUCCESS otherwise.

• CS_OUT_OF_ELEMENTS if there are no blocks of kind syn_kind,
• CS_SUCCESS on success.

• CS_OUT_OF_ELEMENTS if there are no blocks of kind syn_kind,
• CS_SUCCESS on success.

• CS_OUT_OF_ELEMENTS if iteration is complete and there are no spans left to retrieve,
• CS_SUCCESS on success.

• CS_OUT_OF_ELEMENTS if the specified compilation unit has no PDGs,
• CS_SUCCESS on success.

• CS_OUT_OF_ELEMENTS if the iterator has finished and there are no cs_pdg elements left to retrieve,
• CS_SUCCESS on success.

• CS_SUCCESS on success.
• CS_OUT_OF_ELEMENTS if no nonlocal cs_abs_loc could be retrieved and no iterator set up.

• the file static variables in U
• any global variables referenced in U
• any string literals in U

To iterate over local variables for PDGs in the compilation unit, use a cs_uid_pdgs_iter iterator (cs_uid_pdgs_iter_first(), cs_uid_pdgs_iter_next(), cs_uid_pdgs_iter_close()) and a cs_pdg_locals_iter iterator (cs_pdg_locals_iter_first(), cs_pdg_locals_iter_next(), cs_pdg_locals_iter_close()).

Note that neither a UID nonlocals iterator nor a PDG locals iterator will access symbols (cs_abs_loc) of kind cs_abs_loc_kind_param. To iterate over these, call cs_abs_loc_get_param() with increasing num argument until it returns CS_ELEMENT_NOT_PRESENT.

• CS_SUCCESS on success.
• CS_OUT_OF_ELEMENTS if there are no elements left to retrieve (the iterator traversal has finished).

• CS_SUCCESS on success.
• CS_ERROR_OVERFLOW if there is no room in the rewriting namespace to add a new compilation unit.
• CS_REPLACED if a unique cs_uid could not be generated.
• CS_INTERNAL_ERROR_UNKNOWN otherwise.

• cs_true if uid corresponds to a user-generated compilation unit.
• cs_false if uid does not correspond to a user-generated compilation unit.

• Compilation units generated in the back end.
• Compilation units created with cs_uid_create().
• Library models.

• cs_true if uid corresponds to a library model compilation unit.
• cs_false if uid does not correspond to a library model compilation unit.

• cs_true if uid corresponds to a rewriting compilation unit.
• cs_false if uid does not correspond to a rewriting compilation unit.

• cs_true if uid corresponds to a back end compilation unit.
• cs_false if uid does not correspond to a back end compilation unit.

• CS_SUCCESS if uid corresponds to a compilation unit generated by the front end,
• CS_ERROR_UID_NOT_FOUND if uid corresponds to a compilation unit generated in the back end or by cs_uid_create(),
• CS_ERROR_UID_NOT_FOUND if there is no compilation unit corresponding to uid.

• CS_SUCCESS if the compilation unit indicated by uid exists.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if the compilation unit identified by cuid does not exist,
• CS_GENERATED_COMPILATION if cuid represents a compilation that was created with cs_uid_create() or generated in the back end.

• CS_SUCCESS on success.
• CS_ERROR_UID_NOT_FOUND if the compilation unit identified by cuid does not exist.
• CS_GENERATED_COMPILATION if cuid represents a compilation that was created with cs_uid_create() or generated in the back end.

• CS_ERROR_INVALID_SFID if there is no file corresponding to sfid,
• CS_SUCCESS otherwise.

• CS_ELEMENT_NOT_PRESENT if the analyzed project contains no instances of the specified source file.
• CS_SUCCESS otherwise.

• CS_SUCCESS on success.
• CS_OUT_OF_ELEMENTS if the analyzed project contains no instances of the specified source file.

• CS_SUCCESS on success.
• CS_OUT_OF_ELEMENTS if there are no elements left to retrieve (the iterator traversal has finished).

• CS_TRUNCATED if pdg_list is not large enough to hold the entire cs_pdg list,
• CS_SUCCESS otherwise.

• Windows: this path is the downcased version of the one returned by cs_sfid_string(), with backslash directory separators replaced by forward slashes.
• Mac: this path is the downcased version of the one output by cs_sfid_string().
• Otherwise: this path is the same as the one output by cs_sfid_string().

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

Use cs_sfid_string() to get the unnormalized version of the path.

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

Use cs_sfid_normalized_string() to get the normalized version of the path.

• Windows: this path is the downcased version of the one returned by cs_sf_string(), with backslash directory separators replaced by forward slashes.
• Mac: this path is the downcased version of the one output by cs_sf_string().
• Otherwise: this path is the same as the one output by cs_sf_string().

This function entails less user overhead than calling cs_sf_arbitrary_sfid() followed by cs_file_get_normalized_include_name(), 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.

Use cs_sf_string() to get the unnormalized version of the path.

This function entails less user overhead than calling cs_sf_arbitrary_sfid() followed by cs_file_get_include_name(), 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.

Use cs_sf_normalized_string() to get the normalized version of the path.

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

• N<0 if sf_a considered less than sf_b
• N==0 if sf_a considered equal to sf_b
• N>0 if sf_a considered greater than sf_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_sf values in A1, and a2 and b2 be the cs_sf values in A2 that correspond to a1 and b1 respectively. Then cs_sf_stable_compare(a1,b1)==cs_sf_stable_compare(a2,b2).

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

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

• N<0 if sfid_a considered less than sfid_b
• N==0 if sfid_a considered equal to sfid_b
• N>0 if sfid_a considered greater than sfid_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_sfid values in A1, and a2 and b2 be the cs_sfid values in A2 that correspond to a1 and b1 respectively. Then cs_sfid_stable_compare(a1,b1)==cs_sfid_stable_compare(a2,b2).

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

• Windows: this path is the downcased version of the one returned by cs_uid_filename_string(), with backslash directory separators replaced by forward slashes.
• Mac: this path is the downcased version of the one output by cs_uid_filename_string().
• Otherwise: this path is the same as the one output by cs_uid_filename_string().

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

Use cs_uid_filename_string() to get the unnormalized version of the path.

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

Use cs_uid_normalized_filename_string() to get the normalized version of the path.

This function entails less user overhead than calling cs_file_language() followed by cs_language_name(), 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.

• 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 uid_handle is not valid,
• CS_ERROR_IO_READ_PAST_EOF if the handle parameter is too short to be a valid handle.

• 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 sf_handle is not valid,
• CS_ERROR_IO_READ_PAST_EOF if the handle parameter is too short to be a valid handle.

• 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 sfid_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 sfid matching sfid_handle.