]> git.eshelyaron.com Git - emacs.git/commitdiff
(Symbol Plists): Add safe-get.
authorKim F. Storm <storm@cua.dk>
Tue, 19 Apr 2005 09:11:51 +0000 (09:11 +0000)
committerKim F. Storm <storm@cua.dk>
Tue, 19 Apr 2005 09:11:51 +0000 (09:11 +0000)
Mention that `get' may signal an error.

lispref/symbols.texi

index 92c8b0f1e821125d8f385ca47c2f97f10379e848..2c81cb9493c289e1ee9aec7a0efe54f37a4775df 100644 (file)
@@ -496,6 +496,8 @@ This function finds the value of the property named @var{property} in
 @var{symbol}'s property list.  If there is no such property, @code{nil}
 is returned.  Thus, there is no distinction between a value of
 @code{nil} and the absence of the property.
+A @code{wrong-type-argument} error may be signaled if @var{symbol}
+has a malformed property list.
 
 The name @var{property} is compared with the existing property names
 using @code{eq}, so any object is a legitimate property.
@@ -503,6 +505,12 @@ using @code{eq}, so any object is a legitimate property.
 See @code{put} for an example.
 @end defun
 
+@defun safe-get symbol property
+This function finds the value of the property named @var{property} in
+@var{symbol}'s property list.  Unlike @code{get}, it just returns
+@code{nil} if @var{symbol} has a malformed property list.
+@end defun
+
 @defun put symbol property value
 This function puts @var{value} onto @var{symbol}'s property list under
 the property name @var{property}, replacing any previous property value.