1.. Licensed to the Apache Software Foundation (ASF) under one or more
2   contributor license agreements.  See the NOTICE file distributed
3   with this work for additional information regarding copyright
4   ownership.  The ASF licenses this file to you under the Apache
5   License, Version 2.0 (the "License"); you may not use this file
6   except in compliance with the License.  You may obtain a copy of
7   the License at
8
9   http://www.apache.org/licenses/LICENSE-2.0
10
11   Unless required by applicable law or agreed to in writing, software
12   distributed under the License is distributed on an "AS IS" BASIS,
13   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14   implied.  See the License for the specific language governing
15   permissions and limitations under the License.
16
17.. include:: ../../../common.defs
18
19.. default-domain:: c
20
21TSRemapFrom/ToUrlGet
22********************
23
24Synopsis
25========
26
27.. code-block:: cpp
28
29    #include <ts/ts.h>
30
31.. function:: TSReturnCode TSRemapFromUrlGet(TSHttpTxn txnp, TSMLoc * urlLocp)
32.. function:: TSReturnCode TSRemapToUrlGet(TSHttpTxn txnp, TSMLoc * urlLocp)
33
34Description
35===========
36
37These functions are useful for transactions where the URL is remapped, due to matching a line in :file:`remap.config`.
38:func:`TSRemapFromUrlGet` returns the *from* URL in the matching line in :file:`remap.config`.
39:func:`TSRemapToUrlGet` returns the *to* URL in the matching line in :file:`remap.config`.
40This info is available at or after the :c:data:`TS_HTTP_POST_REMAP_HOOK` hook.  If the function returns
41:data:`TS_SUCCESS`, the location of the URL is put into the variable pointed to by :arg:`urlLocp`.  On error, the function
42returns :data:`TS_ERROR`.
43