X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session_file.c;h=08de48c2001d996b5e1295430fcd28b9e8475ed1;hb=0f8522bf74af8abfe8601e978b2e0d0e40b1a124;hp=d6d3d8228901c93f6709c5a571c7fb65ffa05126;hpb=464d12c72aa8d83acccccbbc0bc755fbb9d542c0;p=libsigrok.git

diff --git a/session_file.c b/session_file.c
index d6d3d822..08de48c2 100644
--- a/session_file.c
+++ b/session_file.c
@@ -17,20 +17,29 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "config.h"
 #include <string.h>
 #include <stdlib.h>
 #include <unistd.h>
 #include <zip.h>
 #include <glib.h>
 #include <glib/gstdio.h>
+#include "config.h"
 #include "sigrok.h"
 #include "sigrok-internal.h"
 
 extern struct sr_session *session;
 extern struct sr_device_plugin session_driver;
 
-int sr_session_load(const char *filename)
+/**
+ * Load the session from the specified filename.
+ *
+ * @param filename The name of the session file to load. Must not be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments,
+ *         SR_ERR_MALLOC upon memory allocation errors, or SR_ERR upon
+ *         other errors.
+ */
+SR_API int sr_session_load(const char *filename)
 {
 	GKeyFile *kf;
 	GPtrArray *capturefiles;
@@ -43,7 +52,12 @@ int sr_session_load(const char *filename)
 	int ret, err, probenum, devcnt, i, j;
 	uint64_t tmp_u64, total_probes, enabled_probes, p;
 	char **sections, **keys, *metafile, *val, c;
-	char probename[SR_MAX_PROBENAME_LEN];
+	char probename[SR_MAX_PROBENAME_LEN + 1];
+
+	if (!filename) {
+		sr_err("session file: %s: filename was NULL", __func__);
+		return SR_ERR_ARG;
+	}
 
 	if (!(archive = zip_open(filename, 0, &err))) {
 		sr_dbg("Failed to open session file: zip error %d", err);
@@ -144,6 +158,15 @@ int sr_session_load(const char *filename)
 	return SR_OK;
 }
 
+/**
+ * Save the current session to the specified file.
+ *
+ * @param filename The name of the file where to save the current session.
+ *                 Must not be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
+ *         upon other errors.
+ */
 int sr_session_save(const char *filename)
 {
 	GSList *l, *p, *d;
@@ -157,6 +180,11 @@ int sr_session_save(const char *filename)
 	uint64_t samplerate;
 	char version[1], rawname[16], metafile[32], *buf, *s;
 
+	if (!filename) {
+		sr_err("session file: %s: filename was NULL", __func__);
+		return SR_ERR_ARG;
+	}
+
 	/* Quietly delete it first, libzip wants replace ops otherwise. */
 	unlink(filename);
 	if (!(zipfile = zip_open(filename, ZIP_CREATE, &error)))