NetGetJoinInformation

The NetGetJoinInformation function retrieves join status information for the specified computer.

Security Requirements

No special group membership is required to successfully execute the NetGetJoinInformation function.

NET_API_STATUS NetGetJoinInformation(
  LPCWSTR lpServer,
  LPWSTR *lpNameBuffer,
  PNETSETUP_JOIN_STATUS BufferType
);

Parameters

lpServer

[in] Pointer to a constant null-terminated Unicode character string that specifies the name of the computer on which to call the function. The string must begin with \\. If this parameter is NULL, the local computer is used.

lpNameBuffer

[out] Pointer to the buffer that receives the name of the domain or workgroup to which the computer is joined. This buffer is allocated by the system and must be freed using the NetApiBufferFree function.

BufferType

[out] Receives the join status of the specified computer. This parameter can have one of the following values.

typedef enum _NETSETUP_JOIN_STATUS {

    NetSetupUnknownStatus = 0,
    NetSetupUnjoined,
    NetSetupWorkgroupName,
    NetSetupDomainName

} NETSETUP_JOIN_STATUS, *PNETSETUP_JOIN_STATUS;

These values have the following meanings.

Value	Meaning
NetSetupUnknownStatus	The status is unknown.
NetSetupUnjoined	The computer is not joined.
NetSetupWorkgroupName	The computer is joined to a workgroup.
NetSetupDomainName	The computer is joined to a domain.

Return Values

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value can be the following error code or one of the Win32 error codes.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Lmjoin.h; include Lm.h.
  Library: Use Netapi32.lib.

See Also

Network Management Overview, Network Management Functions, NetGetJoinableOUs