GetServerDirectoryReq

GetServerDirectoryReq 1:

This method activates the GetServerDirectoryReq service. A client can use this service to query which logical devices or files are implemented on a specific server.

METHOD GetServerDirectoryReq : BOOL
VAR_INPUT
    ipServer  : I_AcsiCommonIntelligentElectronicDeviceClass;
    eClass    : E_AcsiServerDirectoryClass;
    hUser     : PVOID;
    ipSink    : I_ScsmGetServerDirectoryCnfEventSink;
END_VAR
VAR_OUTPUT
    nInvokeID : UDINT;
    ipResult  : I_AsyncServiceResultClass;
END_VAR

ipServer: Interface pointer of type I_AcsiCommonIntelligentElectronicDeviceClass.

eClass: Server class of type E_AcsiServerDirectoryClass. This parameter specifies whether logical devices or files are to be queried.

hUser: Optional user-defined parameter or pointer. Any value for this parameter can be transferred in the methods for service activation (XyzMethodReq). The value is then mirrored in the event handling routine for the service feedback.

ipSink: Interface pointer of type I_ScsmGetServerDirectoryCnfEventSink of an object with a user-defined implementation of the event handling routine OnGetServerDirectoryCnf. This parameter is optional and reserved for future use. The pointer value 0 defines the parameter as optional.

ipResult: Interface pointer of type: I_AsyncServiceResultClass This pointer can be used to query and monitor the status/progress and the result of the service execution.

nInvokeID: Identifies the service activation. Each new service activation (XyzMethodReq) is numbered consecutively. A copy of this number is mirrored in the service feedback (OnXyzMethodCnf).

Return parameter: Positive feedback (TRUE) if the service primitive was sent/started successfully, negative feedback (FALSE) on error.