Syntax

  #include <nwthread.h>  
   
  int ReturnNLMVersionInfoFromFile  (  
     BYTE   *__pathName  
     LONG   *majorVersion,   
     LONG   *minorVersion,   
     LONG   *revision,   
     LONG   *year,   
     LONG   *month,   
     LONG   *day,   
     BYTE   *copyrightString  
     BYTE   *description); 
  

Parameters

__pathName

(IN) Points to the path to the NLM file whose version information is to be returned.

majorVersion

(OUT) Points to the major version number of the NLM.

minorVersion

(OUT) Points to the minor version number of the NLM.

revision

(OUT) Points to the revision number of the NLM.

year

(OUT) Points to the number of the year that the NLM was created.

month

(OUT) Points to the number of the month that the NLM was created.

day

(OUT) Points to the number of the day that the NLM was created.

copyrightString

(OUT) Points to a buffer that receives an ASCIIZ string containing the copyright string of the NLM. Buffer size should be 256 bytes.

description

(OUT) Points to a buffer that receives an ASCIIZ string containing the name that is displayed when the NLM is loaded. Buffer size should be 128 bytes.

Return Values

The following table lists return values and descriptions.

Remarks

While __pathName must be supplied, the other parameters can be set to NULL if you do not want the information they return.

The NLM specified by __pathName does not need to be running for this function to retrieve its information.

The information for majorVersion, minorVersion, revision, copyrightString, and description are set with linker options when the NLM applications are linked. For more information about the linker options, see Using a Linker.

The buffer description points to should be at least 128 bytes.

For the NetWare 3.11 OS, this function was made available in CLIB.NLM, version 3.11b.

See Also

MapNLMIDToHandle, FindNLMHandle, ReturnNLMVersionInformation