If the method succeeds, the return value is the number of
characters copied into the string buffer, not including the
terminating null character. If the
client ID does not specify a valid client session,
the method will return zero.
This method returns the full path to the current working directory
for the specified client session. For example, if the server root
directory is C:\ProgramData\MyServer and the current working directory
for the client is /Research/Documents, this method will return
C:\ProgramData\MyServer\Research\Documents as the current working
directory for the client session.
It is important to note that the current working directory for
client sessions is virtual, and does not reflect the current working
directory for the server process. To change the current working
directory for a client, use the ChangeClientDirectory
method.
This method should only be used with client sessions that have
been authenticated. Unauthenticated clients are not assigned a current
working directory and this method will return zero, with the last
error code set to ST_ERROR_AUTHENTICATION_REQUIRED.
To convert a full path to the virtual path for a specific client
session, use the GetClientVirtualPath method.