GuiSymbol functions

developers/functions/gui/GuiSymbolLogAdd.md

@@ -3,23 +3,26 @@
 Function description.
 
 ```c++
-Function definition.
+void GuiSymbolLogAdd(const char* message);
 ```
 
 ## Parameters
 
-`param1` Parameter description.
+`message` String containing the message to add to the symbol log. Ensure that a carriage line and return feed are included with the string for it to properly display it. Encoding is UTF-8.
 
 ## Return Value
 
-Return value description.
+This function does not return a value.
 
 ## Example
 
 ```c++
-Example code.
+GuiSymbolLogAdd(&szMsg);
 ```
 
 ## Related functions
 
-- List of related functions
+- [GuiSymbolLogClear](./GuiSymbolLogClear.md)
+- [GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)
+- [GuiSymbolSetProgress](./GuiSymbolSetProgress.md)
+- [GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)

developers/functions/gui/GuiSymbolLogClear.md

@@ -3,23 +3,26 @@
 Function description.
 
 ```c++
-Function definition.
+void GuiSymbolLogClear();
 ```
 
 ## Parameters
 
-`param1` Parameter description.
+This function has no parameters.
 
 ## Return Value
 
-Return value description.
+This function does not return a value.
 
 ## Example
 
 ```c++
-Example code.
+GuiSymbolLogClear();
 ```
 
 ## Related functions
 
-- List of related functions
+- [GuiSymbolLogAdd](./GuiSymbolLogAdd.md)
+- [GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)
+- [GuiSymbolSetProgress](./GuiSymbolSetProgress.md)
+- [GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)

developers/functions/gui/GuiSymbolRefreshCurrent.md

@@ -1,25 +1,28 @@
 # GuiSymbolRefreshCurrent
 
-Function description.
+Refreshes the symbol view list of symbols and exports.
 
 ```c++
-Function definition.
+void GuiSymbolRefreshCurrent();
 ```
 
 ## Parameters
 
-`param1` Parameter description.
+This function has no parameters.
 
 ## Return Value
 
-Return value description.
+This function does not return a value.
 
 ## Example
 
 ```c++
-Example code.
+GuiSymbolRefreshCurrent();
 ```
 
 ## Related functions
 
-- List of related functions
+- [GuiSymbolLogAdd](./GuiSymbolLogAdd.md)
+- [GuiSymbolLogClear](./GuiSymbolLogClear.md)
+- [GuiSymbolSetProgress](./GuiSymbolSetProgress.md)
+- [GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)

developers/functions/gui/GuiSymbolSetProgress.md

@@ -1,25 +1,28 @@
 # GuiSymbolSetProgress
 
-Function description.
+Sets the progress bar in the symbol view based on the integer value supplied. This can be used to convey to the user an operation and how close it is to completion, for example with searches.
 
 ```c++
-Function definition.
+void GuiSymbolSetProgress(int percent);
 ```
 
 ## Parameters
 
-`param1` Parameter description.
+`percent` an integer representing the percentage to set for the progress bar.
 
 ## Return Value
 
-Return value description.
+This function does not return a value.
 
 ## Example
 
 ```c++
-Example code.
+GuiSymbolSetProgress(50);
 ```
 
 ## Related functions
 
-- List of related functions
+- [GuiSymbolLogAdd](./GuiSymbolLogAdd.md)
+- [GuiSymbolLogClear](./GuiSymbolLogClear.md)
+- [GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)
+- [GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)

developers/functions/gui/GuiSymbolUpdateModuleList.md

@@ -1,25 +1,47 @@
 # GuiSymbolUpdateModuleList
 
-Function description.
+Refreshes the symbol view modules list.
 
 ```c++
-Function definition.
+void GuiSymbolUpdateModuleList(int count, SYMBOLMODULEINFO* modules)
 ```
 
 ## Parameters
 
-`param1` Parameter description.
+`count` An integer representing the number of symbol module's to update.
+
+`modules` A SYMBOLMODULEINFO variable that will hold the symbol module information.
 
 ## Return Value
 
-Return value description.
+This function does not return a value.
 
 ## Example
 
 ```c++
-Example code.
+// Build the vector of modules
+std::vector<SYMBOLMODULEINFO> modList;
+
+if(!SymGetModuleList(&modList))
+{
+	GuiSymbolUpdateModuleList(0, nullptr);
+	return;
+}
+
+// Create a new array to be sent to the GUI thread
+size_t moduleCount = modList.size();
+SYMBOLMODULEINFO* data = (SYMBOLMODULEINFO*)BridgeAlloc(moduleCount * sizeof(SYMBOLMODULEINFO));
+
+// Direct copy from std::vector data
+memcpy(data, modList.data(), moduleCount * sizeof(SYMBOLMODULEINFO));
+
+// Send the module data to the GUI for updating
+GuiSymbolUpdateModuleList((int)moduleCount, data);
 ```
 
 ## Related functions
 
-- List of related functions
+- [GuiSymbolLogAdd](./GuiSymbolLogAdd.md)
+- [GuiSymbolLogClear](./GuiSymbolLogClear.md)
+- [GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)
+- [GuiSymbolSetProgress](./GuiSymbolSetProgress.md)