php-doc-en/reference/mssql/functions/mssql-guid-string.xml
Torben Wilson af4410a7e1 Normalized the sgml-default-dtd-file local-variable line for those
still using this, after discussion on the phpdoc list.
From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced.



git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
2009-09-25 07:04:39 +00:00

98 lines
2.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id='function.mssql-guid-string' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mssql_guid_string</refname>
<refpurpose>Converts a 16 byte binary GUID to a string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>mssql_guid_string</methodname>
<methodparam><type>string</type><parameter>binary</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>short_format</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Converts a 16 byte binary GUID to a string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>binary</parameter></term>
<listitem>
<para>
A 16 byte binary GUID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>short_format</parameter></term>
<listitem>
<para>
Whenever to use short to use short format, defaults to &false;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the converted string on success.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>mssql_guid_string</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$binary = '19555081977808608437941339997619274330352755554827939936';
var_dump(mssql_guid_string($binary));
var_dump(mssql_guid_string($binary, true));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(36) "35353931-3035-3138-3937-373830383630"
string(32) "31393535353038313937373830383630"
]]>
</screen>
</example>
</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:"~/.phpdoc/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
-->