| .. 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:: c |
| |
| TSfread |
| ******* |
| |
| Synopsis |
| ======== |
| |
| .. code-block:: cpp |
| |
| #include <ts/ts.h> |
| |
| .. function:: ssize_t TSfread(TSFile filep, void * buf, size_t length) |
| |
| Description |
| =========== |
| |
| Attempts to read :arg:`length` bytes of data from the file pointed to by |
| :arg:`filep` into the buffer :arg:`buf`. The behavior is undefined if |
| :arg:`length` is greater than SSIZE_MAX. |
| |
| Return Value |
| ============ |
| |
| Returns the number of bytes read on success, or -1 on failure. |
