BALTECH Docs |
C API for BALTECH SDK
|
brp_errcode brp_VHL_ResolveFilename | ( | brp_protocol | protocol, |
char * | FileName, | ||
unsigned * | Id | ||
) |
This command returns the ID of a VHL file based on its filename.
To to do, the command searches for a file whose configuration value VhlCfg.File.Filename matches the passed Filename exactly.
Use this ID to reference the VHL file in the following commands:
We strongly recommend you don't hardcode file IDs, but always resolve them via this command. Otherwise, your application won't work anymore if e.g. a project manager later merges VHL files into a different configuration using BALTECH ConfigEditor. This process may result in a new ID, but not in a new name.
[in] | protocol | used to execute the command |
[in] | FileName | Name of VHL file The filename is case sensitive. Exactly 1 file with the given name must exist. If there are several or no files with exactly this name,BRP_VHL_ErrConfig is returned. |
[out] | Id | ID of VHL file |