From 0dae265b05f4f263f5db362bc86d0753fbde6d8f Mon Sep 17 00:00:00 2001 From: krangelov Date: Thu, 9 Sep 2021 07:25:57 +0200 Subject: [PATCH] expand the comment about PgfExn --- src/runtime/c/pgf/pgf.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/runtime/c/pgf/pgf.h b/src/runtime/c/pgf/pgf.h index 8ba239b60..68578e710 100644 --- a/src/runtime/c/pgf/pgf.h +++ b/src/runtime/c/pgf/pgf.h @@ -56,6 +56,9 @@ typedef struct { * from a system call, then type will be PGF_EXN_SYSTEM_ERROR and * the field code will contain the value of errno from the C runtime. * The field msg will be NULL or it may contain a file name. + * The file name will be the same string that was passed when the API + * function was called. This means that the string does not have to + * be freed from the error handling code. * * - If the exception was caused by factors related to the GF runtime * itself, then the error type is PGF_EXN_PGF_ERROR, and the field