Function ProDocumentFileContentsRead
Description
Reads the contents of a short file from a location on disk or in Windchill.
Note: Not intended for CAD model files.
Synopsis
#include <ProUtil.h>
ProDocumentFileContentsRead | |
( ProPath source_file /* (In) The path to the file, provided by functions such as ProFileMdlnameOpen() and ProFileMdlfiletypeOpen(). */ ProPath document_name /* (In) If present, the name of the document, with source_file being the name of the secondary content on the document. If NULL, read the primary content of source_file. Ignored for non-Windchill locations. */ ProArray* contents /* (Out) A ProArray of chars from the file, which caller must free using ProArrayFree(). */ ) |
Returns
The function succeeded. | |
One or more inputs was invalid. | |
The input file was not found or improper. | |
File was longer than ProArrayMaxCountGet(sizeof(char). | |
No permission to read the input file. | |
Not supported for CAD models. | |
The function failed. |
User Guide References