Share via

3.1.4.16.1 GetSiteNameFromSiteID (Opnum 3)

  • Article

The GetSiteNameFromSiteId method is received by the server in an RPC_REQUEST packet. In response, the server returns a string name for the specific integer site ID, which is a concept that is implemented on the administration system (it is an implementation detail).

 HRESULT GetSiteNameFromSiteId(
   [in] DWORD dwSiteId,
   [out, retval] BSTR* pbstrSiteName
 );

dwSiteId: The unique site ID number that is represented in a double-word format. Note that "0" is not a valid site ID.

pbstrSiteName: Contains the string that represents the unique site name for the specified site ID.

Return Values: The server MUST return zero if it successfully processes the message that is received from the client. In this case, *pbstrSiteName is not NULL. If processing fails, the server MUST return a nonzero HRESULT code as defined in [MS-ERREF]. The following table describes the error conditions that MUST be handled and the corresponding error codes. A server MAY return additional implementation-specific error codes.

Return value/code

Description

0X00000000

NO_ERROR

The operation completed successfully.

0X80070057 

ERROR_INVALID_PARAMETER

One or more parameters are incorrect or null.

0X00000008 

ERROR_NOT_ENOUGH_MEMORY

Not enough memory is available to process this command.

0X80070002

ERROR_FILE_NOT_FOUND

The configuration has no site with ID dwSiteId.

0X80070490

ERROR_NOT_FOUND

The configuration contains no sites.