1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glGetObjectPtrLabel">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>glGetObjectPtrLabel
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glGetObjectPtrLabel
</refname>
17 <refpurpose>retrieve the label of a sync object identified by a pointer
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glGetObjectPtrLabel
</function></funcdef>
23 <paramdef>void *
<parameter>ptr
</parameter></paramdef>
24 <paramdef>GLsizei
<parameter>bifSize
</parameter></paramdef>
25 <paramdef>GLsizei *
<parameter>length
</parameter></paramdef>
26 <paramdef>char *
<parameter>label
</parameter></paramdef>
30 <refsect1 id=
"parameters"><title>Parameters
</title>
33 <term><parameter>ptr
</parameter></term>
36 The name of the sync object whose label to retrieve.
41 <term><parameter>bufSize
</parameter></term>
44 The length of the buffer whose address is in
<parameter>label
</parameter>.
49 <term><parameter>length
</parameter></term>
52 The address of a variable to receive the length of the object label.
57 <term><parameter>label
</parameter></term>
60 The address of a string that will receive the object label.
66 <refsect1 id=
"description"><title>Description
</title>
68 <function>glGetObjectPtrLabel
</function> retrieves the label of the sync object identified by
69 <parameter>ptr
</parameter>.
72 <parameter>label
</parameter> is the address of a string that will be used to store the object label.
73 <parameter>bufSize
</parameter> specifies the number of characters in the array identified by
<parameter>label
</parameter>.
74 <parameter>length
</parameter> contains the address of a variable which will receive the the number of characters in the object label.
75 If
<parameter>length
</parameter> is NULL, then it is ignored and no data is written. Likewise, if
<parameter>label
</parameter>
76 is NULL, or if
<parameter>bufSize
</parameter> is zero then no data is written to
<parameter>label
</parameter>.
79 <refsect1 id=
"errors"><title>Errors
</title>
81 <constant>GL_INVALID_ENUM
</constant> is generated if
<parameter>identifier
</parameter>
82 is not one of the accepted object types.
85 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>ptr
</parameter>
86 is not the name of an existing sync object.
89 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>bufSize
</parameter> is
93 If not NULL,
<parameter>length
</parameter> and
<parameter>label
</parameter> should be addresses
94 to which the client has write access, otherwise undefined behavior, including process termination
98 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
100 <citerefentry><refentrytitle>glGet
</refentrytitle></citerefentry> with argument
<constant>GL_MAX_LABEL_LENGTH
</constant>.
103 <refsect1 id=
"seealso"><title>See Also
</title>
105 <citerefentry><refentrytitle>glPushDebugGroup
</refentrytitle></citerefentry>,
106 <citerefentry><refentrytitle>glPopDebugGroup
</refentrytitle></citerefentry>,
107 <citerefentry><refentrytitle>glObjectLabel
</refentrytitle></citerefentry>,
108 <citerefentry><refentrytitle>glGetObjectLabel
</refentrytitle></citerefentry>.
111 <refsect1 id=
"Copyright"><title>Copyright
</title>
113 Copyright
<trademark class=
"copyright"></trademark> 2012 Khronos Group.
114 This material may be distributed subject to the terms and conditions set forth in
115 the Open Publication License, v
1.0,
8 June
1999.
116 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.