Imported Upstream version 2.14.2
[platform/upstream/fontconfig.git] / doc / fcconstant.fncs
index 2ead0a6..1d8ffc8 100644 (file)
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  * PERFORMANCE OF THIS SOFTWARE.
  */
-@RET@          FcBool
-@FUNC@         FcNameRegisterConstants 
-@TYPE1@                const FcConstant *              @ARG1@          consts
-@TYPE2@                int%                            @ARG2@          nconsts
-@PURPOSE@      Register symbolic constants
+@RET@           FcBool
+@FUNC@          FcNameRegisterConstants
+@TYPE1@         const FcConstant *              @ARG1@          consts
+@TYPE2@         int%                            @ARG2@          nconsts
+@PURPOSE@       Register symbolic constants
 @DESC@
-Register <parameter>nconsts</parameter> new symbolic constants. Returns
-FcFalse if the constants cannot be registered (due to allocation failure).
-Otherwise returns FcTrue.
+Deprecated.  Does nothing.  Returns FcFalse.
 @@
 
-@RET@          FcBool
-@FUNC@         FcNameUnregisterConstants
-@TYPE1@                const FcConstant *              @ARG1@          consts
-@TYPE2@                int%                            @ARG2@          nconsts
-@PURPOSE@      Unregister symbolic constants
+@RET@           FcBool
+@FUNC@          FcNameUnregisterConstants
+@TYPE1@         const FcConstant *              @ARG1@          consts
+@TYPE2@         int%                            @ARG2@          nconsts
+@PURPOSE@       Unregister symbolic constants
 @DESC@
-Unregister <parameter>nconsts</parameter> symbolic constants. Returns
-FcFalse if the specified constants were not registered. Otherwise returns
-FcTrue.
+Deprecated.  Does nothing.  Returns FcFalse.
 @@
 
-@RET@          const FcConstant *
-@FUNC@         FcNameGetConstant
-@TYPE1@                FcChar8 *                       @ARG1@          string
-@PURPOSE@      Lookup symbolic constant
+@RET@           const FcConstant *
+@FUNC@          FcNameGetConstant
+@TYPE1@         FcChar8 *                       @ARG1@          string
+@PURPOSE@       Lookup symbolic constant
 @DESC@
 Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
 @@
 
-@RET@          FcBool
-@FUNC@         FcNameConstant
-@TYPE1@                FcChar8 *                       @ARG1@          string
-@TYPE2@                int *                           @ARG2@          result
-@PURPOSE@      Get the value for a symbolic constant
+@RET@           const FcConstant *
+@FUNC@          FcNameGetConstantFor
+@TYPE1@         FcChar8 *                       @ARG1@          string
+@TYPE2@         char *                          @ARG2@          object
+@PURPOSE@       Lookup symbolic constant For object
+@DESC@
+Return the FcConstant structure related to symbolic constant <parameter>string</parameter>
+for <parameter>object</parameter>.
+@@
+
+@RET@           FcBool
+@FUNC@          FcNameConstant
+@TYPE1@         FcChar8 *                       @ARG1@          string
+@TYPE2@         int *                           @ARG2@          result
+@PURPOSE@       Get the value for a symbolic constant
 @DESC@
 Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
 placing the value of the constant in <parameter>result</parameter> if present.