php-doc-en/reference/id3/functions/id3-get-frame-short-name.xml
2004-12-21 22:15:25 +00:00

71 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.id3-get-frame-short-name">
<refnamediv>
<refname>id3_get_frame_short_name</refname>
<refpurpose>Get the short name of an ID3v2 frame</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>id3_get_frame_short_name</methodname>
<methodparam><type>string</type><parameter>frameId</parameter></methodparam>
</methodsynopsis>
<para>
<function>id3_get_frame_short_name</function> returns the short name for an
ID3v2 frame.
</para>
<para>
</para>
<para>
<example>
<title><function>id3_get_frame_short_name</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$shortName = id3_get_frame_short_name("TOLY");
echo $shortName;
?>
]]>
</programlisting>
<para>
This will output:
</para>
<screen>
<![CDATA[
originalLyricist
]]>
</screen>
</example>
</para>
<para>
The values returned by <function>id3_get_short_name</function> are used in the
array returned by <function>id3_get_tag</function>.
</para>
<para>
See also <function>id3_get_frame_long_name</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->