2d8e388d3abdd135ad5ebd7e62b5789adc7c05e4
[AGL/documentation.git] / docs / 3_Developer_Guides / 6_AFB_Helper_Guide / 3.7.5_Filescan_Utils.md
1 ---
2 edit_link: ''
3 title: Filescan Utils
4 origin_url: >-
5   https://git.automotivelinux.org/src/libafb-helpers/plain/docs/filescan-utils.md?h=master
6 ---
7
8 <!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/afb-helpers-function-references-afb-helpers-book.yml -->
9
10 # Filescan utils functions reference
11
12 ## const char *GetMiddleName(const char *name)
13
14 Get rid of the binder name prefix 'afbd-'
15
16 * name will be typically the full binder name
17
18 Returns the process middle name of the running binder.
19
20 ## const char *GetBinderName()
21
22 Get the Binder Name without the prefix set by the AGL appfw 'afbd-'
23
24 Returns the Binder name without the prefix.
25
26 ## json_object* ScanForConfig (const char* searchPath, CtlScanDirModeT mode, const char *prefix, const char *extension)
27
28 Scan a directory searching all files matching pattern: 'prefix*extention'.
29
30 * `searchPath`: directory where to begin the searching.
31 * `mode`: either or not the search will be recursive.
32 * `prefix`: file prefix that will be looking for.
33 * `extention`: file extention that will be looking for.
34
35 Returns a json_object array of object with 2 parts a 'fullpath' describing the
36 fullpath to reach the file and 'filename' containing the matched files.
37
38 ## char *GetAFBRootDirPathUsingFd(int fd)
39
40 Get the binder root directory path (the path specified with '--rootdir' option
41 at binder launch, if the option is not used, the path from where the binder
42 is launched) using binder root directory file descriptor.
43
44 * `fd` : Binder root directory file descriptor.
45
46 Returns a string representing the path to binder root directory.
47
48 ## char *GetAFBRootDirPath(afb_api_t apiHandle)
49
50 For binding with a version >= 3, same as 'GetAFBRootDirPathUsingFd' function,
51 but use pointer to the AFB API as parameter instead of
52 binder root directory file descriptor.
53
54 * `apiHandle` : pointer to the AFB API.
55
56 Returns a string representing the path to binder root directory.
57
58 ## char* GetBindingDirPath()
59
60 For binding with a version <= 2, same as 'GetAFBRootDirPath' function,
61 but the pointer to the AFB API is not needed.
62 Kept for compatibility issues.
63
64 ## char* GetBindingDirPath(afb_api_t api)
65
66 For binding with a version >= 3, same as 'GetAFBRootDirPath' function.
67 Deprecated, please use 'GetAFBRootDirPath' function.
68 Kept for compatibility issues.
69
70 ## char *GetRunningBindingDirPath(afb_api_t api)
71
72 For binding with a version >= 3, get the binding directory path
73 (the path to the directory that contains the binding).
74
75 * `api` : pointer to the AFB API.
76
77 Returns a string representing the path to the binding directory.
78
79 ## const char *getEnvDirList(const char *prefix, const char *suffix)
80
81 Get the environment directory colon separated path list. This take the prefix
82 add the binder's name then the suffix as environment variable name and also
83 search for another variable without the binder's name (so only prefix+suffix).
84
85 * `prefix`: Environment variable prefix
86 * `suffix`: Environment variable suffix
87
88 Returns a string representing a colon separated path list or NULL is case of
89 error or none environment variables found.