| .. Licensed to the Apache Software Foundation (ASF) under one or more | |
| contributor license agreements. See the NOTICE file distributed | |
| with this work for additional information regarding copyright | |
| ownership. The ASF licenses this file to you under the Apache | |
| License, Version 2.0 (the "License"); you may not use this file | |
| except in compliance with the License. You may obtain a copy of | |
| the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, software | |
| distributed under the License is distributed on an "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| implied. See the License for the specific language governing | |
| permissions and limitations under the License. | |
| .. include:: ../../../common.defs | |
| .. default-domain:: cpp | |
| TSMimeHdrFieldRemove | |
| ******************** | |
| Synopsis | |
| ======== | |
| .. code-block:: cpp | |
| #include <ts/ts.h> | |
| .. function:: TSReturnCode TSMimeHdrFieldRemove(TSMBuffer bufp, TSMLoc hdr, TSMLoc field) | |
| Description | |
| =========== | |
| Removes the MIME field located at :arg:`field` within :arg:`bufp` from the | |
| header located at :arg:`hdr` within :arg:`bufp`. | |
| If the specified field cannot be found in the list of fields associated with | |
| the header then nothing is done. | |
| .. note:: | |
| Removing the field does not destroy the field. It only detaches the | |
| field, hiding it from the printed output. The field can be | |
| reattached with a call to :func:`TSMimeHdrFieldAppend`. If you | |
| do not use the detached field you should destroy it with a call to | |
| :func:`TSMimeHdrFieldDestroy` and release the handle field with a | |
| call to :func:`TSHandleMLocRelease`. |