docs: update resources API docs
This commit is contained in:
37
docs/api/resources/filearchive/getsize.md
Normal file
37
docs/api/resources/filearchive/getsize.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# FileArchive::GetSize
|
||||
|
||||
获取文件大小。
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
size_t GetSize(const Containers::String& fileName) const override;
|
||||
```
|
||||
|
||||
## 详细描述
|
||||
|
||||
获取归档内指定文件的字节大小。文件路径是相对于归档目录的路径。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数 | 类型 | 描述 |
|
||||
|------|------|------|
|
||||
| `fileName` | `const Containers::String&` | 要查询的文件名(相对于归档路径) |
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `size_t` | 文件字节大小,文件不存在或归档无效时返回 0 |
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
FileArchive archive;
|
||||
archive.Open("resources/");
|
||||
|
||||
size_t size = archive.GetSize("textures/player.png");
|
||||
if (size > 0) {
|
||||
// 文件存在,准备读取
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user