<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>pg_escape_string</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Pgtcl Reference Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Query Execution Commands"
HREF="pgtcl-ref-query.html"><LINK
REL="PREVIOUS"
TITLE="pg_result"
HREF="pg-result.html"><LINK
REL="NEXT"
TITLE="pg_quote"
HREF="pg-quote.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
NAME="creation"
CONTENT="2004-11-09T00:53:06"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Pgtcl Reference Manual: The PostgreSQL Tcl Interface</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="pg-result.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="pg-quote.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="PG-ESCAPE-STRING"
></A
>pg_escape_string</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1635"
></A
><H2
>Name</H2
>pg_escape_string -- Escape a string for use in an SQL string constant</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1638"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>pg_escape_string <VAR
CLASS="PARAMETER"
>string</VAR
></PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1641"
></A
><H2
>Description</H2
><P
><CODE
CLASS="FUNCTION"
>pg_escape_string</CODE
> returns its argument with added
characters which makes it safe for use in single-quoted SQL string
constants. That is, it returns the string with all single quote marks
and backslash characters doubled.
</P
><P
>For example, <TT
CLASS="LITERAL"
>pg_escape_string {a'b\c}</TT
> returns
the string <TT
CLASS="LITERAL"
>a''b\\c</TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1648"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><VAR
CLASS="REPLACEABLE"
>string</VAR
></DT
><DD
><P
> The string to escape.
</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1656"
></A
><H2
>Return Value</H2
><P
> The string argument, with added characters.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1659"
></A
><H2
>Notes</H2
><P
> See also <A
HREF="pg-quote.html"
>pg_quote</A
>.
</P
><P
> This command uses or emulates the <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
>
<SPAN
CLASS="APPLICATION"
>libpq</SPAN
>
function <CODE
CLASS="FUNCTION"
>PQescapeString</CODE
>.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="pg-result.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="pg-quote.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>pg_result</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="pgtcl-ref-query.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>pg_quote</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
